{ "openapi": "3.0.3", "info": { "title": "Bnchmrk Partner API", "version": "2.2.1", "description": "The **Bnchmrk Partner API** is a comprehensive REST API designed for seamless integration with employee benefits management systems. Built on enterprise-grade infrastructure, it enables partners to programmatically manage employer records, benefit plans, and user access controls.\n\n## 🚀 Core Capabilities\n\n### Data Management\n- **Employer Records**: Create and manage company profiles with industry classifications (NAICS), geographic presence, and organizational metadata\n- **Benefit Plans**: Full lifecycle management for Medical/Rx, Dental, Vision, Basic Life, Voluntary Life, and Disability insurance plans\n- **User & Access Control**: Granular permission management with division-based data isolation\n\n### Integration Features\n- **RESTful Design**: Predictable resource-based URLs with standard HTTP methods\n- **JSON-First**: All requests and responses use JSON with consistent schema validation\n- **Real-time Operations**: Immediate data consistency across all endpoints\n- **Comprehensive Validation**: Built-in data integrity checks and business rule enforcement\n\n## 🔐 Authentication & Security\n\nAll API requests require token-based authentication via the `Authorization` header:\n```\nAuthorization: Token YOUR_API_TOKEN_HERE\n```\n\n**Security Best Practices:**\n- All requests must use HTTPS/TLS encryption\n- API tokens are environment-specific (production vs staging)\n- Implement proper token rotation and storage practices", "contact": { "name": "Bnchmrk Support", "email": "support@bnchmrk.com", "url": "https://www.bnchmrk.com/contact" } }, "externalDocs": { "description": "Additional API Documentation and Guides", "url": "https://www.bnchmrk.com/developers/docs" }, "tags": [ { "name": "Employers", "description": "Employer records serve as the foundational entity in the Bnchmrk ecosystem, representing companies, organizations, or clients for whom employee benefit plans are administered.\n\n### 📋 Data Requirements\n\n**Essential Information:**\n- Unique company name and website URL\n- Employee count for accurate plan sizing\n- NAICS industry classification codes (6-digit)\n- Geographic presence (US state abbreviations)\n- Division assignment for data access control\n\n**Industry Classification:**\nUse standard NAICS codes to ensure accurate benchmarking comparisons. Multiple codes can be assigned to reflect diverse business operations.\n\n### 🔄 Workflow Integration\n\n1. **Create Employer** → Establish company profile\n2. **Add Benefit Plans** → Link insurance products to employer\n3. **Assign Users** → Grant access to specific team members\n4. **Generate Reports** → Access benchmarking analytics" }, { "name": "Medical/Rx Plans", "description": "Medical and Prescription (Rx) plans represent the core healthcare coverage offerings, encompassing doctor visits, hospital care, prescription medications, and preventive services.\n\n### 💰 Premium Structure\n\n**Annual Rates (PEPY - Per Employee Per Year):**\nAll premium amounts must be expressed as annual values to ensure consistent benchmarking calculations across different billing cycles.\n\n**Tier Structure:**\n- **Tier 1**: Employee Only\n- **Tier 2**: Employee + Spouse (or Employee + 1 for 3-tier structures)\n- **Tier 3**: Employee + Children (or Family for 2-tier structures)\n- **Tier 4**: Employee + Family\n\n### 🏥 Plan Architecture\n\n**Funding Models:**\n- `FUNDING_FULLY`: Traditional fully-insured plans\n- `FUNDING_LEVEL`: Level-funded arrangements\n- `FUNDING_SELF`: Self-funded with stop-loss protection\n\n**Network Types:**\n- `PPO`: Preferred Provider Organization\n- `HMO`: Health Maintenance Organization\n- `EPO`: Exclusive Provider Organization\n- `POS`: Point of Service\n- `HDHP`: High Deductible Health Plan (HSA-eligible)\n\n### 📊 Cost-Sharing Components\n\nConfigure deductibles, copayments, coinsurance, and out-of-pocket maximums for both in-network and out-of-network services. The API supports granular cost-sharing rules for different service categories.\n\n### ⚠️ Data Integrity\n\n- Maintain one record per distinct plan design\n- Link stop-loss policies to corresponding self-funded medical plans\n- Validate tier pricing consistency and business logic" }, { "name": "Dental Plans", "description": "Dental benefit plans provide coverage for oral healthcare services, from routine cleanings and preventive care to major restorative procedures and orthodontic treatment.\n\n### 🦷 Coverage Categories\n\n**Service Classifications:**\n- **Preventive**: Cleanings, exams, X-rays (typically 100% coverage)\n- **Basic**: Fillings, extractions, minor procedures\n- **Major**: Crowns, bridges, major restorative work\n- **Orthodontia**: Braces and corrective treatments (separate lifetime maximum)\n\n### 💳 Plan Types\n\n**Network Models:**\n- `DPPO`: Dental Preferred Provider Organization\n- `DMO`: Dental Maintenance Organization (HMO-style)\n\n### 💰 Financial Structure\n\n**Annual Maximums:**\nSet coverage limits for general dental services and separate orthodontic maximums (typically lifetime limits).\n\n**Cost-Sharing:**\nConfigure deductibles and coinsurance percentages for each service category, with separate in-network and out-of-network provisions." }, { "name": "Vision Plans", "description": "Vision benefit plans provide coverage for eye care services, including routine eye exams, corrective lenses, frames, and contact lenses.\n\n### 👁️ Coverage Components\n\n**Core Services:**\n- **Eye Exams**: Annual or bi-annual comprehensive eye examinations\n- **Lenses**: Prescription eyeglass lenses with various coatings\n- **Frames**: Eyeglass frame allowances and upgrade options\n- **Contacts**: Contact lens allowances (alternative to glasses)\n\n### 📅 Benefit Frequency\n\nConfigure service frequencies in months (e.g., 12 months for annual benefits, 24 months for bi-annual):\n- Exams: Typically 12-24 months\n- Lenses: Usually 12-24 months\n- Frames: Often 24 months\n- Contacts: Generally 12 months\n\n### 💸 Cost Structure\n\n**Allowance vs. Copay Models:**\nPlans may use fixed copayments for services or allowance amounts with member responsibility for costs exceeding the allowance." }, { "name": "Basic Life and AD&D Plans", "description": "Basic Life and Accidental Death & Dismemberment (AD&D) plans provide employer-sponsored financial protection for employees' beneficiaries in the event of death or serious injury.\n\n### 💼 Benefit Calculation Methods\n\nThe `type` field determines how the death benefit is calculated:\n\n**Flat Amount Plans (`FLAT_AMOUNT`):**\nFixed death benefit regardless of salary (e.g., $50,000 for all eligible employees). The `flat_amount` field is required.\n\n**Salary Multiple Plans (`MULTIPLE_OF_SALARY`):**\nDeath benefit calculated as a multiple of annual salary, with an optional maximum cap:\n- Common multiples: 1x, 2x, 3x annual salary\n- The `multiple` field is required\n- `multiple_max` caps the total benefit amount\n\n### 🛟 AD&D Coverage\n\nThe `add` field indicates whether Accidental Death & Dismemberment coverage is included with, or offered alongside, the life insurance policy.\n\n### 👥 Employee Classifications\n\n**Coverage Tiers:**\nDifferent employee classes may have varying benefit levels. Create separate plan records for each distinct class." }, { "name": "Voluntary Life and AD&D Plans", "description": "Voluntary Life and Accidental Death & Dismemberment (AD&D) plans provide employee-elected supplemental life coverage, allowing employees to purchase additional protection for themselves and their dependents.\n\n### 💰 Coverage Maximums\n\nVoluntary Life plans are defined by the maximum coverage amounts available to the employee and their dependents:\n- `max`: Maximum total death benefit available to the employee\n- `max_spouse`: Maximum coverage available to the employee's spouse\n- `max_children`: Maximum coverage available to the employee's children\n\n### 📝 Guarantee Issue\n\nThe `guarantee_issue` amount is the coverage an employee can elect without providing evidence of insurability. Amounts above this threshold typically require medical underwriting.\n\n### 🛟 AD&D Coverage\n\nThe `add` field indicates whether Accidental Death & Dismemberment coverage is included with, or offered alongside, the voluntary life policy.\n\n### 👥 Employee Classifications\n\n**Coverage Tiers:**\nDifferent employee classes may have varying coverage maximums or election options. Create separate plan records for each distinct class." }, { "name": "Short-Term Disability Plans", "description": "Short-Term Disability (STD) plans provide temporary income replacement for employees unable to work due to illness or injury, typically covering periods up to 52 weeks.\n\n### 📊 Benefit Calculation\n\n**Income Replacement:**\n- Percentage of weekly earnings (typically 60-70%)\n- Maximum weekly benefit amounts\n- Step-down provisions (higher initial percentage, lower after specified period)\n\n### ⏱️ Elimination Periods\n\n**Waiting Periods Before Benefits Begin:**\n- Injury-related disabilities: Often 0-7 days\n- Illness-related disabilities: Typically 7-14 days\n\n### 📅 Benefit Duration\n\nMaximum benefit periods typically range from 13-52 weeks, varying by plan design and state regulations." }, { "name": "Long-Term Disability Plans", "description": "Long-Term Disability (LTD) plans provide extended income replacement for employees with prolonged disabilities, offering coverage from the end of STD benefits until retirement age or recovery.\n\n### 💵 Monthly Benefits\n\n**Income Replacement:**\n- Percentage of monthly pre-disability earnings (typically 60-67%)\n- Maximum monthly benefit caps\n- Integration with Social Security and other income sources\n\n### ⏳ Elimination Periods\n\n**Waiting Period:**\nTime period from disability onset until LTD benefits begin (typically 90-180 days, often coordinated with STD benefit exhaustion).\n\n### 🏥 Definition of Disability\n\nPlans typically use a two-stage definition:\n1. **Own Occupation**: Unable to perform duties of regular job (initial period)\n2. **Any Occupation**: Unable to perform any job for which qualified (ongoing period)" }, { "name": "Stop Loss Plans", "description": "Stop Loss insurance provides financial protection for self-funded health plans against catastrophic claims, limiting the employer's exposure to large medical expenses.\n\n### 🛡️ Coverage Types\n\n**Specific Stop Loss:**\nProtects against high-cost claims for individual plan participants. Reimburses expenses above the specific deductible (attachment point) for each covered person.\n\n**Aggregate Stop Loss:**\nProtects against higher-than-expected total claims across the entire plan population. Reimburses when total claims exceed the aggregate attachment point.\n\n### 🎯 Laser Provisions\n\n**Individual Lasers:**\nHigher specific deductibles applied to particular individuals with known high-cost conditions or claims history. Track the number of active lasers for accurate pricing.\n\n### 🔗 Plan Relationships\n\nStop Loss policies must be linked to their underlying self-funded medical/Rx plans to ensure proper benchmarking and analysis.\n\n### 💰 Premium Structure\n\nRates typically expressed as per-employee-per-month (PEPM) or annual amounts, varying by coverage tier and risk profile." }, { "name": "Supplemental Plans", "description": "Supplemental plans capture the voluntary and ancillary benefits an employer offers alongside its core medical, dental, vision, life, and disability coverage.\n\n### 🧩 Offered Benefits\n\nA supplemental plan is defined by which ancillary benefits the employer makes available. Each is a yes/no indicator:\n- **Critical Illness** — lump-sum benefit on diagnosis of a covered serious illness\n- **Hospital Indemnity** — fixed benefit for hospital admission and confinement\n- **Accident** — benefit for injuries and accident-related care\n- **Cancer** — benefit specific to cancer diagnosis and treatment\n- **Pet** — insurance for employees' pets\n- **Legal Assistance** — access to legal services and counsel\n- **Credit Protection** — credit monitoring and identity protection services\n- **Tuition Reimbursement** — employer support for continued education\n\n### 📋 Data Requirements\n\nAll eight offered-benefit indicators are required. Set each to true if the benefit is offered under the plan, or false if it is not.\n\n### 🔄 Workflow Integration\n\nSupplemental plans are created and maintained through the supplemental plan endpoints, then surface on the employer record alongside other benefit plans." }, { "name": "Manage Users", "description": "User management enables programmatic control over access to your Bnchmrk account, implementing role-based permissions and data isolation through division-based security.\n\n### 👤 User Lifecycle\n\n**Account Creation:**\n- Unique usernames generated automatically by the system\n- Email addresses must be unique across the platform\n- Users assigned to specific divisions for data access control\n\n**Access Management:**\n- Division-based permissions ensure data isolation\n- Users can only access employers and plans within their assigned divisions\n- Support for multi-division access for administrative users\n\n### 🏢 Division Architecture\n\n**Data Segmentation:**\nDivisions provide secure data boundaries, ensuring users only access authorized employer records and associated benefit plans.\n\n**Organizational Flexibility:**\n- Map divisions to internal teams, client groups, or geographic regions\n- Support for complex organizational structures\n- Granular control over data visibility and editing permissions\n\n### 🔐 Security Model\n\n**Principle of Least Privilege:**\nUsers receive minimum necessary access to perform their functions, with explicit division assignments controlling data visibility." } ], "servers": [ { "url": "https://api.bnchmrk.com/partner", "description": "Production Environment - Live data, rate-limited" }, { "url": "https://api-testing.bnchmrk.com/partner", "description": "Staging Environment - Test data, higher rate limits for development" } ], "paths": { "/employers/": { "post": { "summary": "Create Employer", "tags": [ "Employers" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Provide a unique employer name to identify and differentiate. Please create only one record per employer." }, "url": { "type": "string", "description": "Unique web address for employer. Should start with 'https://' or 'http://'." }, "size": { "type": "string", "description": "Number of full-time eligible employees." }, "naics_codes": { "type": "array", "items": { "type": "string" }, "uniqueItems": true, "maxItems": 4, "description": "List of 6-digit NAICS codes. Each code must be 6 digits. A maximum of 4 codes may be assigned per employer." }, "location_states": { "type": "array", "items": { "type": "string" }, "uniqueItems": true, "description": "List of US states with physical locations. Each entry is a capitalized 2-letter abbreviation (e.g. CA, NY, TX). Washington, DC is supported and entered as 'DC'." }, "other_filters": { "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true, "description": "List of filter UUIDs applied to the employer. Standard filters available to all accounts: 'Government Contractor' (a0924d18-5f7b-4643-8a2c-5de17be898c3) and 'Non-Profit Organization' (8c2bb207-44c1-404e-b377-c2d00f40211b). Some licenses support additional custom filters. Send an empty array if none apply." }, "division": { "type": "string", "format": "uuid", "description": "Required. Unique ID of the division the employer belongs to. A division is a dedicated group within an Account that secures benefit data — only users assigned to a division can view, edit, and report on employers/plans within it. Bnchmrk provides division UUIDs to partners; they can also be retrieved via GET /divisions/list/." } }, "required": [ "name", "url", "size", "naics_codes", "location_states", "other_filters", "division" ] }, "examples": { "std": { "value": { "name": "Sample Employer", "url": "http://www.employer.com", "size": "155", "naics_codes": [ "123456", "987654" ], "location_states": [ "CA", "FL", "TX" ], "other_filters": [ "81c9bbfc-b683-48cc-b923-4d8ba0483331" ], "division": "2a0183c8-e8e5-4da4-9806-9cd545e3a2d5" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of employer." }, "account": { "type": "string", "format": "uuid", "description": "Unique ID of the Account the employer belongs to." }, "name": { "type": "string", "description": "Provide a unique employer name to identify and differentiate. Please create only one record per employer." }, "url": { "type": "string", "description": "Unique web address for employer. Should start with 'https://' or 'http://'." }, "size": { "type": "string", "description": "Number of full-time eligible employees." }, "naics_codes": { "type": "array", "items": { "type": "string" }, "uniqueItems": true, "maxItems": 4, "description": "List of 6-digit NAICS codes. Each code must be 6 digits. A maximum of 4 codes may be assigned per employer." }, "location_states": { "type": "array", "items": { "type": "string" }, "uniqueItems": true, "description": "List of US states with physical locations. Each entry is a capitalized 2-letter abbreviation (e.g. CA, NY, TX). Washington, DC is supported and entered as 'DC'." }, "other_filters": { "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true, "description": "List of filter UUIDs applied to the employer. Standard filters available to all accounts: 'Government Contractor' (a0924d18-5f7b-4643-8a2c-5de17be898c3) and 'Non-Profit Organization' (8c2bb207-44c1-404e-b377-c2d00f40211b). Some licenses support additional custom filters. Send an empty array if none apply." }, "division": { "type": "string", "format": "uuid", "description": "Required. Unique ID of the division the employer belongs to. A division is a dedicated group within an Account that secures benefit data — only users assigned to a division can view, edit, and report on employers/plans within it. Bnchmrk provides division UUIDs to partners; they can also be retrieved via GET /divisions/list/." }, "plans": { "type": "array", "items": { "type": "object", "properties": { "benefit": { "type": "string", "enum": [ "medical", "dental", "vision", "basiclife", "voluntarylife", "std", "ltd", "stoploss", "supplemental" ], "description": "name of the object" }, "id": { "type": "string", "format": "uuid", "description": "Unique Plan ID assigned by Bnchmrk." } } }, "description": "List of active (in-force) benefit plans offered by employer. Returned in responses only — plans cannot be created or updated through the employer endpoints." }, "plans_expired": { "type": "array", "items": { "type": "object", "properties": { "benefit": { "type": "string", "enum": [ "medical", "dental", "vision", "basiclife", "voluntarylife", "std", "ltd", "stoploss", "supplemental" ], "description": "name of the object" }, "id": { "type": "string", "format": "uuid", "description": "Unique Plan ID assigned by Bnchmrk." } } }, "description": "List of expired benefit plans offered by employer (plans with EXPIRED status). Mirrors the 'plans' field, which contains active plans. Returned in responses only — plans cannot be created or updated through the employer endpoints." }, "created_at": { "type": "string", "format": "date-time", "description": "Date/time record created." }, "created_by": { "type": "string", "format": "uuid", "description": "ID of User who created record." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date/time record updated." }, "updated_by": { "type": "string", "format": "uuid", "description": "ID of User who last updated record." } }, "required": [ "name", "url", "size", "naics_codes", "location_states", "other_filters", "division" ] } } } }, "400": { "description": "Bad request / invalid data", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "array", "description": "List of data validation errors for 'name' field.", "items": { "type": "string" } }, "url": { "type": "array", "description": "List of data validation errors for 'url' field.", "items": { "type": "string" } }, "size": { "type": "array", "description": "List of data validation errors for 'size' field.", "items": { "type": "string" } }, "naics_codes": { "type": "array", "description": "List of data validation errors for 'naics_codes' field.", "items": { "type": "string" } }, "location_states": { "type": "array", "description": "List of data validation errors for 'location_states' field.", "items": { "type": "string" } }, "other_filters": { "type": "array", "description": "List of data validation errors for 'other_filters' field.", "items": { "type": "string" } }, "division": { "type": "array", "description": "List of data validation errors for 'division' field.", "items": { "type": "string" } } } } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/employers/{employerID}/": { "get": { "summary": "Get Employer", "tags": [ "Employers" ], "parameters": [ { "$ref": "#/components/parameters/employerID" } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of employer." }, "account": { "type": "string", "format": "uuid", "description": "Unique ID of the Account the employer belongs to." }, "name": { "type": "string", "description": "Provide a unique employer name to identify and differentiate. Please create only one record per employer." }, "url": { "type": "string", "description": "Unique web address for employer. Should start with 'https://' or 'http://'." }, "size": { "type": "string", "description": "Number of full-time eligible employees." }, "naics_codes": { "type": "array", "items": { "type": "string" }, "uniqueItems": true, "maxItems": 4, "description": "List of 6-digit NAICS codes. Each code must be 6 digits. A maximum of 4 codes may be assigned per employer." }, "location_states": { "type": "array", "items": { "type": "string" }, "uniqueItems": true, "description": "List of US states with physical locations. Each entry is a capitalized 2-letter abbreviation (e.g. CA, NY, TX). Washington, DC is supported and entered as 'DC'." }, "other_filters": { "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true, "description": "List of filter UUIDs applied to the employer. Standard filters available to all accounts: 'Government Contractor' (a0924d18-5f7b-4643-8a2c-5de17be898c3) and 'Non-Profit Organization' (8c2bb207-44c1-404e-b377-c2d00f40211b). Some licenses support additional custom filters. Send an empty array if none apply." }, "division": { "type": "string", "format": "uuid", "description": "Required. Unique ID of the division the employer belongs to. A division is a dedicated group within an Account that secures benefit data — only users assigned to a division can view, edit, and report on employers/plans within it. Bnchmrk provides division UUIDs to partners; they can also be retrieved via GET /divisions/list/." }, "plans": { "type": "array", "items": { "type": "object", "properties": { "benefit": { "type": "string", "enum": [ "medical", "dental", "vision", "basiclife", "voluntarylife", "std", "ltd", "stoploss", "supplemental" ], "description": "name of the object" }, "id": { "type": "string", "format": "uuid", "description": "Unique Plan ID assigned by Bnchmrk." } } }, "description": "List of active (in-force) benefit plans offered by employer. Returned in responses only — plans cannot be created or updated through the employer endpoints." }, "plans_expired": { "type": "array", "items": { "type": "object", "properties": { "benefit": { "type": "string", "enum": [ "medical", "dental", "vision", "basiclife", "voluntarylife", "std", "ltd", "stoploss", "supplemental" ], "description": "name of the object" }, "id": { "type": "string", "format": "uuid", "description": "Unique Plan ID assigned by Bnchmrk." } } }, "description": "List of expired benefit plans offered by employer (plans with EXPIRED status). Mirrors the 'plans' field, which contains active plans. Returned in responses only — plans cannot be created or updated through the employer endpoints." }, "created_at": { "type": "string", "format": "date-time", "description": "Date/time record created." }, "created_by": { "type": "string", "format": "uuid", "description": "ID of User who created record." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date/time record updated." }, "updated_by": { "type": "string", "format": "uuid", "description": "ID of User who last updated record." } }, "required": [ "name", "url", "size", "naics_codes", "location_states", "other_filters", "division" ] } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } }, "put": { "summary": "Update Employer", "tags": [ "Employers" ], "parameters": [ { "$ref": "#/components/parameters/employerID" } ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Provide a unique employer name to identify and differentiate. Please create only one record per employer." }, "url": { "type": "string", "description": "Unique web address for employer. Should start with 'https://' or 'http://'." }, "size": { "type": "string", "description": "Number of full-time eligible employees." }, "naics_codes": { "type": "array", "items": { "type": "string" }, "uniqueItems": true, "maxItems": 4, "description": "List of 6-digit NAICS codes. Each code must be 6 digits. A maximum of 4 codes may be assigned per employer." }, "location_states": { "type": "array", "items": { "type": "string" }, "uniqueItems": true, "description": "List of US states with physical locations. Each entry is a capitalized 2-letter abbreviation (e.g. CA, NY, TX). Washington, DC is supported and entered as 'DC'." }, "other_filters": { "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true, "description": "List of filter UUIDs applied to the employer. Standard filters available to all accounts: 'Government Contractor' (a0924d18-5f7b-4643-8a2c-5de17be898c3) and 'Non-Profit Organization' (8c2bb207-44c1-404e-b377-c2d00f40211b). Some licenses support additional custom filters. Send an empty array if none apply." }, "division": { "type": "string", "format": "uuid", "description": "Required. Unique ID of the division the employer belongs to. A division is a dedicated group within an Account that secures benefit data — only users assigned to a division can view, edit, and report on employers/plans within it. Bnchmrk provides division UUIDs to partners; they can also be retrieved via GET /divisions/list/." } }, "required": [ "name", "url", "size", "naics_codes", "location_states", "other_filters", "division" ] }, "examples": { "std": { "value": { "name": "Sample Employer", "url": "http://www.employer.com", "size": "155", "naics_codes": [ "123456", "987654" ], "location_states": [ "CA", "FL", "TX" ], "other_filters": [ "81c9bbfc-b683-48cc-b923-4d8ba0483331" ], "division": "2a0183c8-e8e5-4da4-9806-9cd545e3a2d5" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of employer." }, "account": { "type": "string", "format": "uuid", "description": "Unique ID of the Account the employer belongs to." }, "name": { "type": "string", "description": "Provide a unique employer name to identify and differentiate. Please create only one record per employer." }, "url": { "type": "string", "description": "Unique web address for employer. Should start with 'https://' or 'http://'." }, "size": { "type": "string", "description": "Number of full-time eligible employees." }, "naics_codes": { "type": "array", "items": { "type": "string" }, "uniqueItems": true, "maxItems": 4, "description": "List of 6-digit NAICS codes. Each code must be 6 digits. A maximum of 4 codes may be assigned per employer." }, "location_states": { "type": "array", "items": { "type": "string" }, "uniqueItems": true, "description": "List of US states with physical locations. Each entry is a capitalized 2-letter abbreviation (e.g. CA, NY, TX). Washington, DC is supported and entered as 'DC'." }, "other_filters": { "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true, "description": "List of filter UUIDs applied to the employer. Standard filters available to all accounts: 'Government Contractor' (a0924d18-5f7b-4643-8a2c-5de17be898c3) and 'Non-Profit Organization' (8c2bb207-44c1-404e-b377-c2d00f40211b). Some licenses support additional custom filters. Send an empty array if none apply." }, "division": { "type": "string", "format": "uuid", "description": "Required. Unique ID of the division the employer belongs to. A division is a dedicated group within an Account that secures benefit data — only users assigned to a division can view, edit, and report on employers/plans within it. Bnchmrk provides division UUIDs to partners; they can also be retrieved via GET /divisions/list/." }, "plans": { "type": "array", "items": { "type": "object", "properties": { "benefit": { "type": "string", "enum": [ "medical", "dental", "vision", "basiclife", "voluntarylife", "std", "ltd", "stoploss", "supplemental" ], "description": "name of the object" }, "id": { "type": "string", "format": "uuid", "description": "Unique Plan ID assigned by Bnchmrk." } } }, "description": "List of active (in-force) benefit plans offered by employer. Returned in responses only — plans cannot be created or updated through the employer endpoints." }, "plans_expired": { "type": "array", "items": { "type": "object", "properties": { "benefit": { "type": "string", "enum": [ "medical", "dental", "vision", "basiclife", "voluntarylife", "std", "ltd", "stoploss", "supplemental" ], "description": "name of the object" }, "id": { "type": "string", "format": "uuid", "description": "Unique Plan ID assigned by Bnchmrk." } } }, "description": "List of expired benefit plans offered by employer (plans with EXPIRED status). Mirrors the 'plans' field, which contains active plans. Returned in responses only — plans cannot be created or updated through the employer endpoints." }, "created_at": { "type": "string", "format": "date-time", "description": "Date/time record created." }, "created_by": { "type": "string", "format": "uuid", "description": "ID of User who created record." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date/time record updated." }, "updated_by": { "type": "string", "format": "uuid", "description": "ID of User who last updated record." } }, "required": [ "name", "url", "size", "naics_codes", "location_states", "other_filters", "division" ] } } } }, "400": { "description": "Bad request / invalid data", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "array", "description": "List of data validation errors for 'name' field.", "items": { "type": "string" } }, "url": { "type": "array", "description": "List of data validation errors for 'url' field.", "items": { "type": "string" } }, "size": { "type": "array", "description": "List of data validation errors for 'size' field.", "items": { "type": "string" } }, "naics_codes": { "type": "array", "description": "List of data validation errors for 'naics_codes' field.", "items": { "type": "string" } }, "location_states": { "type": "array", "description": "List of data validation errors for 'location_states' field.", "items": { "type": "string" } }, "other_filters": { "type": "array", "description": "List of data validation errors for 'other_filters' field.", "items": { "type": "string" } }, "division": { "type": "array", "description": "List of data validation errors for 'division' field.", "items": { "type": "string" } } } } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } }, "delete": { "summary": "Delete Employer", "tags": [ "Employers" ], "parameters": [ { "$ref": "#/components/parameters/employerID" } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/employers/list/": { "get": { "summary": "Get Employers List", "tags": [ "Employers" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk." }, "name": { "type": "string", "description": "Unique employer name to identify and differentiate employers." } } } } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/plans/medical/": { "post": { "summary": "Create Medical Plan", "tags": [ "Medical/Rx Plans" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "funding": { "type": "string", "enum": [ "FUNDING_FULLY", "FUNDING_LEVEL", "FUNDING_SELF" ], "description": "Used to differentiate plans within the benefit class based on how employer shares risk with carrier." }, "t1_ee": { "type": "integer", "description": "Amount paid by a single (tier 1) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t2_ee": { "type": "integer", "description": "Amount paid by an employee + spouse (tier 2) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_ee": { "type": "integer", "description": "Amount paid by an employee + children (tier 3) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_ee": { "type": "integer", "description": "Amount paid by an employee + family (tier 4) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t1_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover a single (tier 1) employee per year (PEPY)." }, "t2_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + spouse (tier 2) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + children (tier 3) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + family (tier 4) employee per year (PEPY)." }, "type": { "type": "string", "enum": [ "PPO", "POS", "EPO", "HMO", "HDHP" ], "description": "Used to differentiate plans within the benefit class based on how benefits are paid." }, "in_ded_single": { "type": "integer", "description": "The dollar amount of eligible expenses a covered single tier employee must pay each year out of pocket before the plan will make payment for eligible benefits in-network." }, "in_ded_family": { "type": "integer", "description": "The dollar amount of eligible expenses a covered family tier employee must pay each year out of pocket before the plan will make payment for eligible benefits in-network." }, "in_max_single": { "type": "integer", "description": "The maximum dollar amount a single tier employee will pay toward in-network expenses within a calendar year. It includes the deductible, coinsurance and copays." }, "in_max_family": { "type": "integer", "description": "The maximum dollar amount a family tier employee will pay toward in-network expenses within a calendar year. It includes the deductible, coinsurance and copays." }, "in_coin": { "type": "integer", "description": "The percentage amount that the employee is expected to cover for in-network services." }, "out_ded_single": { "type": "integer", "description": "The dollar amount of eligible expenses a covered single tier employee must pay each year out of pocket before the plan will make payment for eligible benefits out-of-network." }, "out_ded_family": { "type": "integer", "description": "The dollar amount of eligible expenses a covered family tier employee must pay each year out of pocket before the plan will make payment for eligible benefits out-of-network." }, "out_max_single": { "type": "integer", "description": "The maximum dollar amount a single tier employee will pay toward out-of-network expenses within a calendar year. It includes the deductible, coinsurance and copays." }, "out_max_family": { "type": "integer", "description": "The maximum dollar amount a family tier employee will pay toward out-of-network expenses within a calendar year. It includes the deductible, coinsurance and copays." }, "out_coin": { "type": "integer", "description": "The percentage amount that the employee is expected to cover for out-of-network services." }, "rx_ded_single": { "type": "integer", "description": "Only provide a value here if Rx has a seperate single deductible from Medical; otherwise, set to null." }, "rx_ded_family": { "type": "integer", "description": "Only provide a value here if Rx has a seperate family deductible from Medical; otherwise, set to null." }, "rx_max_single": { "type": "integer", "description": "Only provide a value here if Rx has a seperate single Max OOP from Medical; otherwise, set to null." }, "rx_max_family": { "type": "integer", "description": "Only provide a value here if Rx has a seperate family Max OOP from Medical; otherwise, set to null." }, "rx_coin": { "type": "integer", "description": "The percentage amount that the employee is expected to cover for out-of-network services." }, "pcp_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Primary Care Physician visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "sp_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Specialist Physician visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "er_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Emergency Room visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "uc_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Urgent Care visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "lx_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Basic Lab and Xray services?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "ip_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Inpatient Visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "op_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Outpatient Visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx1_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 1 Generic Rx (retail 30 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx2_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 2 Preferred Brand Rx (retail 30 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx3_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 3 Non-Preferred Brand Rx (retail 30 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx4_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 4 Specialty Rx (retail 30 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx1_mail_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 1 Generic Rx (mail order 90 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx2_mail_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 2 Preferred Brand Rx (mail order 90 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx3_mail_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 3 Non-Preferred Brand Rx (mail order 90 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx4_mail_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 4 Specialty Rx (mail order 90 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "pcp_copay": { "type": "integer", "description": "Single payment that applies to Primary Care Physician visits in-network. Only provide a value if a copay is required." }, "sp_copay": { "type": "integer", "description": "Single payment that applies to Specialist Physician visits in-network. Only provide a value if a copay is required." }, "er_copay": { "type": "integer", "description": "Single payment that applies to Emergency Room visits in-network. Only provide a value if a copay is required." }, "uc_copay": { "type": "integer", "description": "Single payment that applies to Urgent Care visits in-network. Only provide a value if a copay is required." }, "lx_copay": { "type": "integer", "description": "Single payment that applies to Basic Lab & X-ray services in-network. Only provide a value if a copay is required." }, "ip_copay": { "type": "integer", "description": "Single payment that applies to Inpatient Hospital visits in-network. Only provide a value if a copay is required." }, "op_copay": { "type": "integer", "description": "Single payment that applies to Outpatient Hospital visits in-network. Only provide a value if a copay is required." }, "rx1_copay": { "type": "integer", "description": "Single payment that applies to Tier 1 Generic Rx (retail 30 days) in-network. Only provide a value if a copay is required." }, "rx2_copay": { "type": "integer", "description": "Single payment that applies to Tier 2 Preferred Brand Rx (retail 30 days) in-network. Only provide a value if a copay is required." }, "rx3_copay": { "type": "integer", "description": "Single payment that applies to Tier 3 Non-Preferred Brand Rx (retail 30 days) in-network. Only provide a value if a copay is required." }, "rx4_copay": { "type": "integer", "description": "Single payment that applies to Tier 4 Specialty Rx (retail 30 days) in-network. Only provide a value if a copay is required." }, "rx1_mail_copay": { "type": "integer", "description": "Single payment that applies to Tier 1 Generic Rx (mail order 90 days) in-network. Only provide a value if a copay is required." }, "rx2_mail_copay": { "type": "integer", "description": "Single payment that applies to Tier 2 Preferred Brand Rx (mail order 90 days) in-network. Only provide a value if a copay is required." }, "rx3_mail_copay": { "type": "integer", "description": "Single payment that applies to Tier 3 Non-Preferred Brand Rx (mail order 90 days) in-network. Only provide a value if a copay is required." }, "rx4_mail_copay": { "type": "integer", "description": "Single payment that applies to Tier 4 Specialty Rx (mail order 90 days) in-network. Only provide a value if a copay is required." }, "hra": { "type": "boolean", "description": "Is an HRA offered with the Medical/Rx plan?" }, "hsa": { "type": "boolean", "description": "Is an HSA offered with the Medical/Rx plan?" }, "fsa": { "type": "boolean", "description": "Is an FSA offered with the Medical/Rx plan?" }, "age_rated": { "type": "boolean", "description": "Are the premium rates based 100% on age-banded or community ratings?" }, "salary_banding": { "type": "boolean", "description": "Do the employee contributions vary based on employee salary?" }, "tobacco_surcharge": { "type": "integer", "nullable": true, "description": "Additional amount employees are required to pay annually (PEPY) based on tested or self-reported tobacco use. If not required, set to null." }, "spousal_surcharge": { "type": "integer", "nullable": true, "description": "Additional amount employees are required to pay annually (PEPY) based on whether spouse is working/retired and is eligible for medical coverage through their employer/former employer. If not required, set to null." }, "t1_ercdhp": { "type": "integer", "nullable": true, "description": "The amount funded to single tier employees' HSA account each year by the employer" }, "t2_ercdhp": { "type": "integer", "nullable": true, "description": "The amount funded to employee + spouse tier employees' HSA account each year by the employer" }, "t3_ercdhp": { "type": "integer", "nullable": true, "description": "The amount funded to employee + children tier employees' HSA account each year by the employer" }, "t4_ercdhp": { "type": "integer", "nullable": true, "description": "The amount funded to employee + family tier employees' HSA account each year by the employer" } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "funding", "t1_ee", "t2_ee", "t3_ee", "t4_ee", "t1_gross", "t2_gross", "t3_gross", "t4_gross", "type", "in_ded_single", "in_ded_family", "in_max_single", "in_max_family", "in_coin", "pcp_ded_apply", "sp_ded_apply", "er_ded_apply", "uc_ded_apply", "lx_ded_apply", "ip_ded_apply", "op_ded_apply", "rx1_ded_apply", "rx2_ded_apply", "hra", "hsa", "fsa", "age_rated", "salary_banding", "spousal_surcharge", "tobacco_surcharge", "t1_ercdhp", "t2_ercdhp", "t3_ercdhp", "t4_ercdhp" ] }, "examples": { "medical": { "value": { "employer": "7574457f-e9ed-4a65-8baa-72b8088b9f45", "title": "Sample Medical Plan", "carrier": "Aetna", "start_date": "2023-01-01", "end_date": "2023-12-31", "from_plan": "2d373e05-28cb-401a-a0f5-2e8b7c0d524c", "from_action": "RENEWED", "pt": false, "funding": "FUNDING_FULLY", "type": "PPO", "t1_ee": 5190, "t2_ee": 11810, "t3_ee": 9680, "t4_ee": 18700, "t1_gross": 11593, "t2_gross": 23209, "t3_gross": 20055, "t4_gross": 35601, "in_ded_single": 1500, "in_ded_family": 4500, "in_max_single": 4500, "in_max_family": 9000, "in_coin": 20, "out_ded_single": 4500, "out_ded_family": 13500, "out_max_single": 9000, "out_max_family": 18000, "out_coin": 50, "rx_ded_single": null, "rx_ded_family": null, "rx_max_single": null, "rx_max_family": null, "rx_coin": 20, "pcp_ded_apply": "FALSE", "sp_ded_apply": "FALSE", "er_ded_apply": "TRUE_COIN", "uc_ded_apply": "FALSE", "lx_ded_apply": "FALSE", "ip_ded_apply": "TRUE_COIN", "op_ded_apply": "TRUE_COIN", "rx1_ded_apply": "FALSE", "rx2_ded_apply": "FALSE", "rx3_ded_apply": "FALSE", "rx4_ded_apply": "FALSE_COIN", "rx1_mail_ded_apply": "FALSE", "rx2_mail_ded_apply": "FALSE", "rx3_mail_ded_apply": "FALSE", "rx4_mail_ded_apply": "FALSE_COIN", "pcp_copay": 30, "sp_copay": 55, "er_copay": null, "uc_copay": 60, "lx_copay": 55, "ip_copay": null, "op_copay": null, "rx1_copay": 10, "rx2_copay": 30, "rx3_copay": 50, "rx4_copay": null, "rx1_mail_copay": 25, "rx2_mail_copay": 75, "rx3_mail_copay": 125, "rx4_mail_copay": null, "hra": false, "hsa": false, "fsa": true, "age_rated": false, "salary_banding": true, "spousal_surcharge": null, "tobacco_surcharge": null, "t1_ercdhp": null, "t2_ercdhp": null, "t3_ercdhp": null, "t4_ercdhp": null } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of plan." }, "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "funding": { "type": "string", "enum": [ "FUNDING_FULLY", "FUNDING_LEVEL", "FUNDING_SELF" ], "description": "Used to differentiate plans within the benefit class based on how employer shares risk with carrier." }, "t1_ee": { "type": "integer", "description": "Amount paid by a single (tier 1) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t2_ee": { "type": "integer", "description": "Amount paid by an employee + spouse (tier 2) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_ee": { "type": "integer", "description": "Amount paid by an employee + children (tier 3) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_ee": { "type": "integer", "description": "Amount paid by an employee + family (tier 4) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t1_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover a single (tier 1) employee per year (PEPY)." }, "t2_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + spouse (tier 2) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + children (tier 3) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + family (tier 4) employee per year (PEPY)." }, "type": { "type": "string", "enum": [ "PPO", "POS", "EPO", "HMO", "HDHP" ], "description": "Used to differentiate plans within the benefit class based on how benefits are paid." }, "in_ded_single": { "type": "integer", "description": "The dollar amount of eligible expenses a covered single tier employee must pay each year out of pocket before the plan will make payment for eligible benefits in-network." }, "in_ded_family": { "type": "integer", "description": "The dollar amount of eligible expenses a covered family tier employee must pay each year out of pocket before the plan will make payment for eligible benefits in-network." }, "in_max_single": { "type": "integer", "description": "The maximum dollar amount a single tier employee will pay toward in-network expenses within a calendar year. It includes the deductible, coinsurance and copays." }, "in_max_family": { "type": "integer", "description": "The maximum dollar amount a family tier employee will pay toward in-network expenses within a calendar year. It includes the deductible, coinsurance and copays." }, "in_coin": { "type": "integer", "description": "The percentage amount that the employee is expected to cover for in-network services." }, "out_ded_single": { "type": "integer", "description": "The dollar amount of eligible expenses a covered single tier employee must pay each year out of pocket before the plan will make payment for eligible benefits out-of-network." }, "out_ded_family": { "type": "integer", "description": "The dollar amount of eligible expenses a covered family tier employee must pay each year out of pocket before the plan will make payment for eligible benefits out-of-network." }, "out_max_single": { "type": "integer", "description": "The maximum dollar amount a single tier employee will pay toward out-of-network expenses within a calendar year. It includes the deductible, coinsurance and copays." }, "out_max_family": { "type": "integer", "description": "The maximum dollar amount a family tier employee will pay toward out-of-network expenses within a calendar year. It includes the deductible, coinsurance and copays." }, "out_coin": { "type": "integer", "description": "The percentage amount that the employee is expected to cover for out-of-network services." }, "rx_ded_single": { "type": "integer", "description": "Only provide a value here if Rx has a seperate single deductible from Medical; otherwise, set to null." }, "rx_ded_family": { "type": "integer", "description": "Only provide a value here if Rx has a seperate family deductible from Medical; otherwise, set to null." }, "rx_max_single": { "type": "integer", "description": "Only provide a value here if Rx has a seperate single Max OOP from Medical; otherwise, set to null." }, "rx_max_family": { "type": "integer", "description": "Only provide a value here if Rx has a seperate family Max OOP from Medical; otherwise, set to null." }, "rx_coin": { "type": "integer", "description": "The percentage amount that the employee is expected to cover for out-of-network services." }, "pcp_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Primary Care Physician visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "sp_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Specialist Physician visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "er_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Emergency Room visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "uc_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Urgent Care visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "lx_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Basic Lab and Xray services?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "ip_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Inpatient Visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "op_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Outpatient Visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx1_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 1 Generic Rx (retail 30 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx2_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 2 Preferred Brand Rx (retail 30 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx3_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 3 Non-Preferred Brand Rx (retail 30 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx4_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 4 Specialty Rx (retail 30 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx1_mail_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 1 Generic Rx (mail order 90 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx2_mail_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 2 Preferred Brand Rx (mail order 90 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx3_mail_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 3 Non-Preferred Brand Rx (mail order 90 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx4_mail_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 4 Specialty Rx (mail order 90 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "pcp_copay": { "type": "integer", "description": "Single payment that applies to Primary Care Physician visits in-network. Only provide a value if a copay is required." }, "sp_copay": { "type": "integer", "description": "Single payment that applies to Specialist Physician visits in-network. Only provide a value if a copay is required." }, "er_copay": { "type": "integer", "description": "Single payment that applies to Emergency Room visits in-network. Only provide a value if a copay is required." }, "uc_copay": { "type": "integer", "description": "Single payment that applies to Urgent Care visits in-network. Only provide a value if a copay is required." }, "lx_copay": { "type": "integer", "description": "Single payment that applies to Basic Lab & X-ray services in-network. Only provide a value if a copay is required." }, "ip_copay": { "type": "integer", "description": "Single payment that applies to Inpatient Hospital visits in-network. Only provide a value if a copay is required." }, "op_copay": { "type": "integer", "description": "Single payment that applies to Outpatient Hospital visits in-network. Only provide a value if a copay is required." }, "rx1_copay": { "type": "integer", "description": "Single payment that applies to Tier 1 Generic Rx (retail 30 days) in-network. Only provide a value if a copay is required." }, "rx2_copay": { "type": "integer", "description": "Single payment that applies to Tier 2 Preferred Brand Rx (retail 30 days) in-network. Only provide a value if a copay is required." }, "rx3_copay": { "type": "integer", "description": "Single payment that applies to Tier 3 Non-Preferred Brand Rx (retail 30 days) in-network. Only provide a value if a copay is required." }, "rx4_copay": { "type": "integer", "description": "Single payment that applies to Tier 4 Specialty Rx (retail 30 days) in-network. Only provide a value if a copay is required." }, "rx1_mail_copay": { "type": "integer", "description": "Single payment that applies to Tier 1 Generic Rx (mail order 90 days) in-network. Only provide a value if a copay is required." }, "rx2_mail_copay": { "type": "integer", "description": "Single payment that applies to Tier 2 Preferred Brand Rx (mail order 90 days) in-network. Only provide a value if a copay is required." }, "rx3_mail_copay": { "type": "integer", "description": "Single payment that applies to Tier 3 Non-Preferred Brand Rx (mail order 90 days) in-network. Only provide a value if a copay is required." }, "rx4_mail_copay": { "type": "integer", "description": "Single payment that applies to Tier 4 Specialty Rx (mail order 90 days) in-network. Only provide a value if a copay is required." }, "hra": { "type": "boolean", "description": "Is an HRA offered with the Medical/Rx plan?" }, "hsa": { "type": "boolean", "description": "Is an HSA offered with the Medical/Rx plan?" }, "fsa": { "type": "boolean", "description": "Is an FSA offered with the Medical/Rx plan?" }, "age_rated": { "type": "boolean", "description": "Are the premium rates based 100% on age-banded or community ratings?" }, "salary_banding": { "type": "boolean", "description": "Do the employee contributions vary based on employee salary?" }, "tobacco_surcharge": { "type": "integer", "nullable": true, "description": "Additional amount employees are required to pay annually (PEPY) based on tested or self-reported tobacco use. If not required, set to null." }, "spousal_surcharge": { "type": "integer", "nullable": true, "description": "Additional amount employees are required to pay annually (PEPY) based on whether spouse is working/retired and is eligible for medical coverage through their employer/former employer. If not required, set to null." }, "t1_ercdhp": { "type": "integer", "nullable": true, "description": "The amount funded to single tier employees' HSA account each year by the employer" }, "t2_ercdhp": { "type": "integer", "nullable": true, "description": "The amount funded to employee + spouse tier employees' HSA account each year by the employer" }, "t3_ercdhp": { "type": "integer", "nullable": true, "description": "The amount funded to employee + children tier employees' HSA account each year by the employer" }, "t4_ercdhp": { "type": "integer", "nullable": true, "description": "The amount funded to employee + family tier employees' HSA account each year by the employer" } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "funding", "t1_ee", "t2_ee", "t3_ee", "t4_ee", "t1_gross", "t2_gross", "t3_gross", "t4_gross", "type", "in_ded_single", "in_ded_family", "in_max_single", "in_max_family", "in_coin", "pcp_ded_apply", "sp_ded_apply", "er_ded_apply", "uc_ded_apply", "lx_ded_apply", "ip_ded_apply", "op_ded_apply", "rx1_ded_apply", "rx2_ded_apply", "hra", "hsa", "fsa", "age_rated", "salary_banding", "spousal_surcharge", "tobacco_surcharge", "t1_ercdhp", "t2_ercdhp", "t3_ercdhp", "t4_ercdhp" ] } } } }, "400": { "description": "Bad request / invalid data", "content": { "application/json": { "schema": { "type": "object", "properties": { "employer": { "type": "array", "description": "List of data validation errors for 'employer' field.", "items": { "type": "string" } }, "title": { "type": "array", "description": "List of data validation errors for 'title' field.", "items": { "type": "string" } }, "carrier": { "type": "array", "description": "List of data validation errors for 'carrier' field.", "items": { "type": "string" } }, "start_date": { "type": "array", "description": "List of data validation errors for 'start_date' field.", "items": { "type": "string" } }, "end_date": { "type": "array", "description": "List of data validation errors for 'end_date' field.", "items": { "type": "string" } }, "from_plan": { "type": "array", "description": "List of data validation errors for 'from_plan' field.", "items": { "type": "string" } }, "from_action": { "type": "array", "description": "List of data validation errors for 'from_action' field.", "items": { "type": "string" } }, "pt": { "type": "array", "description": "List of data validation errors for 'pt' field.", "items": { "type": "string" } }, "funding": { "type": "array", "description": "List of data validation errors for 'funding' field.", "items": { "type": "string" } }, "t1_ee": { "type": "array", "description": "List of data validation errors for 't1_ee' field.", "items": { "type": "string" } }, "t2_ee": { "type": "array", "description": "List of data validation errors for 't2_ee' field.", "items": { "type": "string" } }, "t3_ee": { "type": "array", "description": "List of data validation errors for 't3_ee' field.", "items": { "type": "string" } }, "t4_ee": { "type": "array", "description": "List of data validation errors for 't4_ee' field.", "items": { "type": "string" } }, "t1_gross": { "type": "array", "description": "List of data validation errors for 't1_gross' field.", "items": { "type": "string" } }, "t2_gross": { "type": "array", "description": "List of data validation errors for 't2_gross' field.", "items": { "type": "string" } }, "t3_gross": { "type": "array", "description": "List of data validation errors for 't3_gross' field.", "items": { "type": "string" } }, "t4_gross": { "type": "array", "description": "List of data validation errors for 't4_gross' field.", "items": { "type": "string" } }, "type": { "type": "array", "description": "List of data validation errors for 'type' field.", "items": { "type": "string" } }, "in_ded_single": { "type": "array", "description": "List of data validation errors for 'in_ded_single' field.", "items": { "type": "string" } }, "in_ded_family": { "type": "array", "description": "List of data validation errors for 'in_ded_family' field.", "items": { "type": "string" } }, "in_max_single": { "type": "array", "description": "List of data validation errors for 'in_max_single' field.", "items": { "type": "string" } }, "in_max_family": { "type": "array", "description": "List of data validation errors for 'in_max_family' field.", "items": { "type": "string" } }, "in_coin": { "type": "array", "description": "List of data validation errors for 'in_coin' field.", "items": { "type": "string" } }, "out_ded_single": { "type": "array", "description": "List of data validation errors for 'out_ded_single' field.", "items": { "type": "string" } }, "out_ded_family": { "type": "array", "description": "List of data validation errors for 'out_ded_family' field.", "items": { "type": "string" } }, "out_max_single": { "type": "array", "description": "List of data validation errors for 'out_max_single' field.", "items": { "type": "string" } }, "out_max_family": { "type": "array", "description": "List of data validation errors for 'out_max_family' field.", "items": { "type": "string" } }, "out_coin": { "type": "array", "description": "List of data validation errors for 'out_coin' field.", "items": { "type": "string" } }, "rx_ded_single": { "type": "array", "description": "List of data validation errors for 'rx_ded_single' field.", "items": { "type": "string" } }, "rx_ded_family": { "type": "array", "description": "List of data validation errors for 'rx_ded_family' field.", "items": { "type": "string" } }, "rx_max_single": { "type": "array", "description": "List of data validation errors for 'rx_max_single' field.", "items": { "type": "string" } }, "rx_max_family": { "type": "array", "description": "List of data validation errors for 'rx_max_family' field.", "items": { "type": "string" } }, "rx_coin": { "type": "array", "description": "List of data validation errors for 'rx_coin' field.", "items": { "type": "string" } }, "pcp_copay": { "type": "array", "description": "List of data validation errors for 'pcp_copay' field.", "items": { "type": "string" } }, "sp_copay": { "type": "array", "description": "List of data validation errors for 'sp_copay' field.", "items": { "type": "string" } }, "er_copay": { "type": "array", "description": "List of data validation errors for 'er_copay' field.", "items": { "type": "string" } }, "uc_copay": { "type": "array", "description": "List of data validation errors for 'uc_copay' field.", "items": { "type": "string" } }, "lx_copay": { "type": "array", "description": "List of data validation errors for 'lx_copay' field.", "items": { "type": "string" } }, "ip_copay": { "type": "array", "description": "List of data validation errors for 'ip_copay' field.", "items": { "type": "string" } }, "op_copay": { "type": "array", "description": "List of data validation errors for 'op_copay' field.", "items": { "type": "string" } }, "rx1_copay": { "type": "array", "description": "List of data validation errors for 'rx1_copay' field.", "items": { "type": "string" } }, "rx2_copay": { "type": "array", "description": "List of data validation errors for 'rx2_copay' field.", "items": { "type": "string" } }, "rx3_copay": { "type": "array", "description": "List of data validation errors for 'rx3_copay' field.", "items": { "type": "string" } }, "rx4_copay": { "type": "array", "description": "List of data validation errors for 'rx4_copay' field.", "items": { "type": "string" } }, "rx1_mail_copay": { "type": "array", "description": "List of data validation errors for 'rx1_mail_copay' field.", "items": { "type": "string" } }, "rx2_mail_copay": { "type": "array", "description": "List of data validation errors for 'rx2_mail_copay' field.", "items": { "type": "string" } }, "rx3_mail_copay": { "type": "array", "description": "List of data validation errors for 'rx3_mail_copay' field.", "items": { "type": "string" } }, "rx4_mail_copay": { "type": "array", "description": "List of data validation errors for 'rx4_mail_copay' field.", "items": { "type": "string" } }, "pcp_ded_apply": { "type": "array", "description": "List of data validation errors for 'pcp_ded_apply' field.", "items": { "type": "string" } }, "sp_ded_apply": { "type": "array", "description": "List of data validation errors for 'sp_ded_apply' field.", "items": { "type": "string" } }, "er_ded_apply": { "type": "array", "description": "List of data validation errors for 'er_ded_apply' field.", "items": { "type": "string" } }, "uc_ded_apply": { "type": "array", "description": "List of data validation errors for 'uc_ded_apply' field.", "items": { "type": "string" } }, "lx_ded_apply": { "type": "array", "description": "List of data validation errors for 'lx_ded_apply' field.", "items": { "type": "string" } }, "ip_ded_apply": { "type": "array", "description": "List of data validation errors for 'ip_ded_apply' field.", "items": { "type": "string" } }, "op_ded_apply": { "type": "array", "description": "List of data validation errors for 'op_ded_apply' field.", "items": { "type": "string" } }, "rx1_ded_apply": { "type": "array", "description": "List of data validation errors for 'rx1_ded_apply' field.", "items": { "type": "string" } }, "rx2_ded_apply": { "type": "array", "description": "List of data validation errors for 'rx2_ded_apply' field.", "items": { "type": "string" } }, "rx3_ded_apply": { "type": "array", "description": "List of data validation errors for 'rx3_ded_apply' field.", "items": { "type": "string" } }, "rx4_ded_apply": { "type": "array", "description": "List of data validation errors for 'rx4_ded_apply' field.", "items": { "type": "string" } }, "rx1_mail_ded_apply": { "type": "array", "description": "List of data validation errors for 'rx1_mail_ded_apply' field.", "items": { "type": "string" } }, "rx2_mail_ded_apply": { "type": "array", "description": "List of data validation errors for 'rx2_mail_ded_apply' field.", "items": { "type": "string" } }, "rx3_mail_ded_apply": { "type": "array", "description": "List of data validation errors for 'rx3_mail_ded_apply' field.", "items": { "type": "string" } }, "rx4_mail_ded_apply": { "type": "array", "description": "List of data validation errors for 'rx4_mail_ded_apply' field.", "items": { "type": "string" } }, "hra": { "type": "array", "description": "List of data validation errors for 'hra' field.", "items": { "type": "string" } }, "hsa": { "type": "array", "description": "List of data validation errors for 'hsa' field.", "items": { "type": "string" } }, "fsa": { "type": "array", "description": "List of data validation errors for 'fsa' field.", "items": { "type": "string" } }, "age_rated": { "type": "array", "description": "List of data validation errors for 'age_rated' field.", "items": { "type": "string" } }, "salary_banding": { "type": "array", "description": "List of data validation errors for 'salary_banding' field.", "items": { "type": "string" } }, "spousal_surcharge": { "type": "array", "description": "List of data validation errors for 'spousal_surcharge' field.", "items": { "type": "string" } }, "tobacco_surcharge": { "type": "array", "description": "List of data validation errors for 'tobacco_surcharge' field.", "items": { "type": "string" } }, "t1_ercdhp": { "type": "array", "description": "List of data validation errors for 't1_ercdhp' field.", "items": { "type": "string" } }, "t2_ercdhp": { "type": "array", "description": "List of data validation errors for 't2_ercdhp' field.", "items": { "type": "string" } }, "t3_ercdhp": { "type": "array", "description": "List of data validation errors for 't3_ercdhp' field.", "items": { "type": "string" } }, "t4_ercdhp": { "type": "array", "description": "List of data validation errors for 't4_ercdhp' field.", "items": { "type": "string" } } } } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/plans/medical/{planID}/": { "get": { "summary": "Get Medical Plan", "tags": [ "Medical/Rx Plans" ], "parameters": [ { "$ref": "#/components/parameters/planID" } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of plan." }, "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "funding": { "type": "string", "enum": [ "FUNDING_FULLY", "FUNDING_LEVEL", "FUNDING_SELF" ], "description": "Used to differentiate plans within the benefit class based on how employer shares risk with carrier." }, "t1_ee": { "type": "integer", "description": "Amount paid by a single (tier 1) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t2_ee": { "type": "integer", "description": "Amount paid by an employee + spouse (tier 2) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_ee": { "type": "integer", "description": "Amount paid by an employee + children (tier 3) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_ee": { "type": "integer", "description": "Amount paid by an employee + family (tier 4) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t1_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover a single (tier 1) employee per year (PEPY)." }, "t2_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + spouse (tier 2) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + children (tier 3) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + family (tier 4) employee per year (PEPY)." }, "type": { "type": "string", "enum": [ "PPO", "POS", "EPO", "HMO", "HDHP" ], "description": "Used to differentiate plans within the benefit class based on how benefits are paid." }, "in_ded_single": { "type": "integer", "description": "The dollar amount of eligible expenses a covered single tier employee must pay each year out of pocket before the plan will make payment for eligible benefits in-network." }, "in_ded_family": { "type": "integer", "description": "The dollar amount of eligible expenses a covered family tier employee must pay each year out of pocket before the plan will make payment for eligible benefits in-network." }, "in_max_single": { "type": "integer", "description": "The maximum dollar amount a single tier employee will pay toward in-network expenses within a calendar year. It includes the deductible, coinsurance and copays." }, "in_max_family": { "type": "integer", "description": "The maximum dollar amount a family tier employee will pay toward in-network expenses within a calendar year. It includes the deductible, coinsurance and copays." }, "in_coin": { "type": "integer", "description": "The percentage amount that the employee is expected to cover for in-network services." }, "out_ded_single": { "type": "integer", "description": "The dollar amount of eligible expenses a covered single tier employee must pay each year out of pocket before the plan will make payment for eligible benefits out-of-network." }, "out_ded_family": { "type": "integer", "description": "The dollar amount of eligible expenses a covered family tier employee must pay each year out of pocket before the plan will make payment for eligible benefits out-of-network." }, "out_max_single": { "type": "integer", "description": "The maximum dollar amount a single tier employee will pay toward out-of-network expenses within a calendar year. It includes the deductible, coinsurance and copays." }, "out_max_family": { "type": "integer", "description": "The maximum dollar amount a family tier employee will pay toward out-of-network expenses within a calendar year. It includes the deductible, coinsurance and copays." }, "out_coin": { "type": "integer", "description": "The percentage amount that the employee is expected to cover for out-of-network services." }, "rx_ded_single": { "type": "integer", "description": "Only provide a value here if Rx has a seperate single deductible from Medical; otherwise, set to null." }, "rx_ded_family": { "type": "integer", "description": "Only provide a value here if Rx has a seperate family deductible from Medical; otherwise, set to null." }, "rx_max_single": { "type": "integer", "description": "Only provide a value here if Rx has a seperate single Max OOP from Medical; otherwise, set to null." }, "rx_max_family": { "type": "integer", "description": "Only provide a value here if Rx has a seperate family Max OOP from Medical; otherwise, set to null." }, "rx_coin": { "type": "integer", "description": "The percentage amount that the employee is expected to cover for out-of-network services." }, "pcp_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Primary Care Physician visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "sp_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Specialist Physician visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "er_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Emergency Room visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "uc_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Urgent Care visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "lx_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Basic Lab and Xray services?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "ip_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Inpatient Visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "op_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Outpatient Visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx1_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 1 Generic Rx (retail 30 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx2_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 2 Preferred Brand Rx (retail 30 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx3_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 3 Non-Preferred Brand Rx (retail 30 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx4_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 4 Specialty Rx (retail 30 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx1_mail_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 1 Generic Rx (mail order 90 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx2_mail_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 2 Preferred Brand Rx (mail order 90 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx3_mail_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 3 Non-Preferred Brand Rx (mail order 90 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx4_mail_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 4 Specialty Rx (mail order 90 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "pcp_copay": { "type": "integer", "description": "Single payment that applies to Primary Care Physician visits in-network. Only provide a value if a copay is required." }, "sp_copay": { "type": "integer", "description": "Single payment that applies to Specialist Physician visits in-network. Only provide a value if a copay is required." }, "er_copay": { "type": "integer", "description": "Single payment that applies to Emergency Room visits in-network. Only provide a value if a copay is required." }, "uc_copay": { "type": "integer", "description": "Single payment that applies to Urgent Care visits in-network. Only provide a value if a copay is required." }, "lx_copay": { "type": "integer", "description": "Single payment that applies to Basic Lab & X-ray services in-network. Only provide a value if a copay is required." }, "ip_copay": { "type": "integer", "description": "Single payment that applies to Inpatient Hospital visits in-network. Only provide a value if a copay is required." }, "op_copay": { "type": "integer", "description": "Single payment that applies to Outpatient Hospital visits in-network. Only provide a value if a copay is required." }, "rx1_copay": { "type": "integer", "description": "Single payment that applies to Tier 1 Generic Rx (retail 30 days) in-network. Only provide a value if a copay is required." }, "rx2_copay": { "type": "integer", "description": "Single payment that applies to Tier 2 Preferred Brand Rx (retail 30 days) in-network. Only provide a value if a copay is required." }, "rx3_copay": { "type": "integer", "description": "Single payment that applies to Tier 3 Non-Preferred Brand Rx (retail 30 days) in-network. Only provide a value if a copay is required." }, "rx4_copay": { "type": "integer", "description": "Single payment that applies to Tier 4 Specialty Rx (retail 30 days) in-network. Only provide a value if a copay is required." }, "rx1_mail_copay": { "type": "integer", "description": "Single payment that applies to Tier 1 Generic Rx (mail order 90 days) in-network. Only provide a value if a copay is required." }, "rx2_mail_copay": { "type": "integer", "description": "Single payment that applies to Tier 2 Preferred Brand Rx (mail order 90 days) in-network. Only provide a value if a copay is required." }, "rx3_mail_copay": { "type": "integer", "description": "Single payment that applies to Tier 3 Non-Preferred Brand Rx (mail order 90 days) in-network. Only provide a value if a copay is required." }, "rx4_mail_copay": { "type": "integer", "description": "Single payment that applies to Tier 4 Specialty Rx (mail order 90 days) in-network. Only provide a value if a copay is required." }, "hra": { "type": "boolean", "description": "Is an HRA offered with the Medical/Rx plan?" }, "hsa": { "type": "boolean", "description": "Is an HSA offered with the Medical/Rx plan?" }, "fsa": { "type": "boolean", "description": "Is an FSA offered with the Medical/Rx plan?" }, "age_rated": { "type": "boolean", "description": "Are the premium rates based 100% on age-banded or community ratings?" }, "salary_banding": { "type": "boolean", "description": "Do the employee contributions vary based on employee salary?" }, "tobacco_surcharge": { "type": "integer", "nullable": true, "description": "Additional amount employees are required to pay annually (PEPY) based on tested or self-reported tobacco use. If not required, set to null." }, "spousal_surcharge": { "type": "integer", "nullable": true, "description": "Additional amount employees are required to pay annually (PEPY) based on whether spouse is working/retired and is eligible for medical coverage through their employer/former employer. If not required, set to null." }, "t1_ercdhp": { "type": "integer", "nullable": true, "description": "The amount funded to single tier employees' HSA account each year by the employer" }, "t2_ercdhp": { "type": "integer", "nullable": true, "description": "The amount funded to employee + spouse tier employees' HSA account each year by the employer" }, "t3_ercdhp": { "type": "integer", "nullable": true, "description": "The amount funded to employee + children tier employees' HSA account each year by the employer" }, "t4_ercdhp": { "type": "integer", "nullable": true, "description": "The amount funded to employee + family tier employees' HSA account each year by the employer" } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "funding", "t1_ee", "t2_ee", "t3_ee", "t4_ee", "t1_gross", "t2_gross", "t3_gross", "t4_gross", "type", "in_ded_single", "in_ded_family", "in_max_single", "in_max_family", "in_coin", "pcp_ded_apply", "sp_ded_apply", "er_ded_apply", "uc_ded_apply", "lx_ded_apply", "ip_ded_apply", "op_ded_apply", "rx1_ded_apply", "rx2_ded_apply", "hra", "hsa", "fsa", "age_rated", "salary_banding", "spousal_surcharge", "tobacco_surcharge", "t1_ercdhp", "t2_ercdhp", "t3_ercdhp", "t4_ercdhp" ] } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } }, "put": { "summary": "Update Medical Plan", "tags": [ "Medical/Rx Plans" ], "parameters": [ { "$ref": "#/components/parameters/planID" } ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "funding": { "type": "string", "enum": [ "FUNDING_FULLY", "FUNDING_LEVEL", "FUNDING_SELF" ], "description": "Used to differentiate plans within the benefit class based on how employer shares risk with carrier." }, "t1_ee": { "type": "integer", "description": "Amount paid by a single (tier 1) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t2_ee": { "type": "integer", "description": "Amount paid by an employee + spouse (tier 2) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_ee": { "type": "integer", "description": "Amount paid by an employee + children (tier 3) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_ee": { "type": "integer", "description": "Amount paid by an employee + family (tier 4) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t1_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover a single (tier 1) employee per year (PEPY)." }, "t2_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + spouse (tier 2) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + children (tier 3) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + family (tier 4) employee per year (PEPY)." }, "type": { "type": "string", "enum": [ "PPO", "POS", "EPO", "HMO", "HDHP" ], "description": "Used to differentiate plans within the benefit class based on how benefits are paid." }, "in_ded_single": { "type": "integer", "description": "The dollar amount of eligible expenses a covered single tier employee must pay each year out of pocket before the plan will make payment for eligible benefits in-network." }, "in_ded_family": { "type": "integer", "description": "The dollar amount of eligible expenses a covered family tier employee must pay each year out of pocket before the plan will make payment for eligible benefits in-network." }, "in_max_single": { "type": "integer", "description": "The maximum dollar amount a single tier employee will pay toward in-network expenses within a calendar year. It includes the deductible, coinsurance and copays." }, "in_max_family": { "type": "integer", "description": "The maximum dollar amount a family tier employee will pay toward in-network expenses within a calendar year. It includes the deductible, coinsurance and copays." }, "in_coin": { "type": "integer", "description": "The percentage amount that the employee is expected to cover for in-network services." }, "out_ded_single": { "type": "integer", "description": "The dollar amount of eligible expenses a covered single tier employee must pay each year out of pocket before the plan will make payment for eligible benefits out-of-network." }, "out_ded_family": { "type": "integer", "description": "The dollar amount of eligible expenses a covered family tier employee must pay each year out of pocket before the plan will make payment for eligible benefits out-of-network." }, "out_max_single": { "type": "integer", "description": "The maximum dollar amount a single tier employee will pay toward out-of-network expenses within a calendar year. It includes the deductible, coinsurance and copays." }, "out_max_family": { "type": "integer", "description": "The maximum dollar amount a family tier employee will pay toward out-of-network expenses within a calendar year. It includes the deductible, coinsurance and copays." }, "out_coin": { "type": "integer", "description": "The percentage amount that the employee is expected to cover for out-of-network services." }, "rx_ded_single": { "type": "integer", "description": "Only provide a value here if Rx has a seperate single deductible from Medical; otherwise, set to null." }, "rx_ded_family": { "type": "integer", "description": "Only provide a value here if Rx has a seperate family deductible from Medical; otherwise, set to null." }, "rx_max_single": { "type": "integer", "description": "Only provide a value here if Rx has a seperate single Max OOP from Medical; otherwise, set to null." }, "rx_max_family": { "type": "integer", "description": "Only provide a value here if Rx has a seperate family Max OOP from Medical; otherwise, set to null." }, "rx_coin": { "type": "integer", "description": "The percentage amount that the employee is expected to cover for out-of-network services." }, "pcp_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Primary Care Physician visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "sp_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Specialist Physician visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "er_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Emergency Room visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "uc_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Urgent Care visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "lx_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Basic Lab and Xray services?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "ip_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Inpatient Visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "op_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Outpatient Visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx1_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 1 Generic Rx (retail 30 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx2_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 2 Preferred Brand Rx (retail 30 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx3_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 3 Non-Preferred Brand Rx (retail 30 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx4_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 4 Specialty Rx (retail 30 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx1_mail_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 1 Generic Rx (mail order 90 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx2_mail_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 2 Preferred Brand Rx (mail order 90 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx3_mail_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 3 Non-Preferred Brand Rx (mail order 90 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx4_mail_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 4 Specialty Rx (mail order 90 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "pcp_copay": { "type": "integer", "description": "Single payment that applies to Primary Care Physician visits in-network. Only provide a value if a copay is required." }, "sp_copay": { "type": "integer", "description": "Single payment that applies to Specialist Physician visits in-network. Only provide a value if a copay is required." }, "er_copay": { "type": "integer", "description": "Single payment that applies to Emergency Room visits in-network. Only provide a value if a copay is required." }, "uc_copay": { "type": "integer", "description": "Single payment that applies to Urgent Care visits in-network. Only provide a value if a copay is required." }, "lx_copay": { "type": "integer", "description": "Single payment that applies to Basic Lab & X-ray services in-network. Only provide a value if a copay is required." }, "ip_copay": { "type": "integer", "description": "Single payment that applies to Inpatient Hospital visits in-network. Only provide a value if a copay is required." }, "op_copay": { "type": "integer", "description": "Single payment that applies to Outpatient Hospital visits in-network. Only provide a value if a copay is required." }, "rx1_copay": { "type": "integer", "description": "Single payment that applies to Tier 1 Generic Rx (retail 30 days) in-network. Only provide a value if a copay is required." }, "rx2_copay": { "type": "integer", "description": "Single payment that applies to Tier 2 Preferred Brand Rx (retail 30 days) in-network. Only provide a value if a copay is required." }, "rx3_copay": { "type": "integer", "description": "Single payment that applies to Tier 3 Non-Preferred Brand Rx (retail 30 days) in-network. Only provide a value if a copay is required." }, "rx4_copay": { "type": "integer", "description": "Single payment that applies to Tier 4 Specialty Rx (retail 30 days) in-network. Only provide a value if a copay is required." }, "rx1_mail_copay": { "type": "integer", "description": "Single payment that applies to Tier 1 Generic Rx (mail order 90 days) in-network. Only provide a value if a copay is required." }, "rx2_mail_copay": { "type": "integer", "description": "Single payment that applies to Tier 2 Preferred Brand Rx (mail order 90 days) in-network. Only provide a value if a copay is required." }, "rx3_mail_copay": { "type": "integer", "description": "Single payment that applies to Tier 3 Non-Preferred Brand Rx (mail order 90 days) in-network. Only provide a value if a copay is required." }, "rx4_mail_copay": { "type": "integer", "description": "Single payment that applies to Tier 4 Specialty Rx (mail order 90 days) in-network. Only provide a value if a copay is required." }, "hra": { "type": "boolean", "description": "Is an HRA offered with the Medical/Rx plan?" }, "hsa": { "type": "boolean", "description": "Is an HSA offered with the Medical/Rx plan?" }, "fsa": { "type": "boolean", "description": "Is an FSA offered with the Medical/Rx plan?" }, "age_rated": { "type": "boolean", "description": "Are the premium rates based 100% on age-banded or community ratings?" }, "salary_banding": { "type": "boolean", "description": "Do the employee contributions vary based on employee salary?" }, "tobacco_surcharge": { "type": "integer", "nullable": true, "description": "Additional amount employees are required to pay annually (PEPY) based on tested or self-reported tobacco use. If not required, set to null." }, "spousal_surcharge": { "type": "integer", "nullable": true, "description": "Additional amount employees are required to pay annually (PEPY) based on whether spouse is working/retired and is eligible for medical coverage through their employer/former employer. If not required, set to null." }, "t1_ercdhp": { "type": "integer", "nullable": true, "description": "The amount funded to single tier employees' HSA account each year by the employer" }, "t2_ercdhp": { "type": "integer", "nullable": true, "description": "The amount funded to employee + spouse tier employees' HSA account each year by the employer" }, "t3_ercdhp": { "type": "integer", "nullable": true, "description": "The amount funded to employee + children tier employees' HSA account each year by the employer" }, "t4_ercdhp": { "type": "integer", "nullable": true, "description": "The amount funded to employee + family tier employees' HSA account each year by the employer" } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "funding", "t1_ee", "t2_ee", "t3_ee", "t4_ee", "t1_gross", "t2_gross", "t3_gross", "t4_gross", "type", "in_ded_single", "in_ded_family", "in_max_single", "in_max_family", "in_coin", "pcp_ded_apply", "sp_ded_apply", "er_ded_apply", "uc_ded_apply", "lx_ded_apply", "ip_ded_apply", "op_ded_apply", "rx1_ded_apply", "rx2_ded_apply", "hra", "hsa", "fsa", "age_rated", "salary_banding", "spousal_surcharge", "tobacco_surcharge", "t1_ercdhp", "t2_ercdhp", "t3_ercdhp", "t4_ercdhp" ] }, "examples": { "medical": { "value": { "employer": "7574457f-e9ed-4a65-8baa-72b8088b9f45", "title": "Sample Medical Plan", "carrier": "Aetna", "start_date": "2023-01-01", "end_date": "2023-12-31", "from_plan": "2d373e05-28cb-401a-a0f5-2e8b7c0d524c", "from_action": "RENEWED", "pt": false, "funding": "FUNDING_FULLY", "type": "PPO", "t1_ee": 5190, "t2_ee": 11810, "t3_ee": 9680, "t4_ee": 18700, "t1_gross": 11593, "t2_gross": 23209, "t3_gross": 20055, "t4_gross": 35601, "in_ded_single": 1500, "in_ded_family": 4500, "in_max_single": 4500, "in_max_family": 9000, "in_coin": 20, "out_ded_single": 4500, "out_ded_family": 13500, "out_max_single": 9000, "out_max_family": 18000, "out_coin": 50, "rx_ded_single": null, "rx_ded_family": null, "rx_max_single": null, "rx_max_family": null, "rx_coin": 20, "pcp_ded_apply": "FALSE", "sp_ded_apply": "FALSE", "er_ded_apply": "TRUE_COIN", "uc_ded_apply": "FALSE", "lx_ded_apply": "FALSE", "ip_ded_apply": "TRUE_COIN", "op_ded_apply": "TRUE_COIN", "rx1_ded_apply": "FALSE", "rx2_ded_apply": "FALSE", "rx3_ded_apply": "FALSE", "rx4_ded_apply": "FALSE_COIN", "rx1_mail_ded_apply": "FALSE", "rx2_mail_ded_apply": "FALSE", "rx3_mail_ded_apply": "FALSE", "rx4_mail_ded_apply": "FALSE_COIN", "pcp_copay": 30, "sp_copay": 55, "er_copay": null, "uc_copay": 60, "lx_copay": 55, "ip_copay": null, "op_copay": null, "rx1_copay": 10, "rx2_copay": 30, "rx3_copay": 50, "rx4_copay": null, "rx1_mail_copay": 25, "rx2_mail_copay": 75, "rx3_mail_copay": 125, "rx4_mail_copay": null, "hra": false, "hsa": false, "fsa": true, "age_rated": false, "salary_banding": true, "spousal_surcharge": null, "tobacco_surcharge": null, "t1_ercdhp": null, "t2_ercdhp": null, "t3_ercdhp": null, "t4_ercdhp": null } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of plan." }, "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "funding": { "type": "string", "enum": [ "FUNDING_FULLY", "FUNDING_LEVEL", "FUNDING_SELF" ], "description": "Used to differentiate plans within the benefit class based on how employer shares risk with carrier." }, "t1_ee": { "type": "integer", "description": "Amount paid by a single (tier 1) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t2_ee": { "type": "integer", "description": "Amount paid by an employee + spouse (tier 2) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_ee": { "type": "integer", "description": "Amount paid by an employee + children (tier 3) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_ee": { "type": "integer", "description": "Amount paid by an employee + family (tier 4) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t1_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover a single (tier 1) employee per year (PEPY)." }, "t2_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + spouse (tier 2) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + children (tier 3) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + family (tier 4) employee per year (PEPY)." }, "type": { "type": "string", "enum": [ "PPO", "POS", "EPO", "HMO", "HDHP" ], "description": "Used to differentiate plans within the benefit class based on how benefits are paid." }, "in_ded_single": { "type": "integer", "description": "The dollar amount of eligible expenses a covered single tier employee must pay each year out of pocket before the plan will make payment for eligible benefits in-network." }, "in_ded_family": { "type": "integer", "description": "The dollar amount of eligible expenses a covered family tier employee must pay each year out of pocket before the plan will make payment for eligible benefits in-network." }, "in_max_single": { "type": "integer", "description": "The maximum dollar amount a single tier employee will pay toward in-network expenses within a calendar year. It includes the deductible, coinsurance and copays." }, "in_max_family": { "type": "integer", "description": "The maximum dollar amount a family tier employee will pay toward in-network expenses within a calendar year. It includes the deductible, coinsurance and copays." }, "in_coin": { "type": "integer", "description": "The percentage amount that the employee is expected to cover for in-network services." }, "out_ded_single": { "type": "integer", "description": "The dollar amount of eligible expenses a covered single tier employee must pay each year out of pocket before the plan will make payment for eligible benefits out-of-network." }, "out_ded_family": { "type": "integer", "description": "The dollar amount of eligible expenses a covered family tier employee must pay each year out of pocket before the plan will make payment for eligible benefits out-of-network." }, "out_max_single": { "type": "integer", "description": "The maximum dollar amount a single tier employee will pay toward out-of-network expenses within a calendar year. It includes the deductible, coinsurance and copays." }, "out_max_family": { "type": "integer", "description": "The maximum dollar amount a family tier employee will pay toward out-of-network expenses within a calendar year. It includes the deductible, coinsurance and copays." }, "out_coin": { "type": "integer", "description": "The percentage amount that the employee is expected to cover for out-of-network services." }, "rx_ded_single": { "type": "integer", "description": "Only provide a value here if Rx has a seperate single deductible from Medical; otherwise, set to null." }, "rx_ded_family": { "type": "integer", "description": "Only provide a value here if Rx has a seperate family deductible from Medical; otherwise, set to null." }, "rx_max_single": { "type": "integer", "description": "Only provide a value here if Rx has a seperate single Max OOP from Medical; otherwise, set to null." }, "rx_max_family": { "type": "integer", "description": "Only provide a value here if Rx has a seperate family Max OOP from Medical; otherwise, set to null." }, "rx_coin": { "type": "integer", "description": "The percentage amount that the employee is expected to cover for out-of-network services." }, "pcp_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Primary Care Physician visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "sp_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Specialist Physician visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "er_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Emergency Room visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "uc_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Urgent Care visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "lx_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Basic Lab and Xray services?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "ip_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Inpatient Visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "op_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Outpatient Visits?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx1_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 1 Generic Rx (retail 30 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx2_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 2 Preferred Brand Rx (retail 30 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx3_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 3 Non-Preferred Brand Rx (retail 30 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx4_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 4 Specialty Rx (retail 30 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx1_mail_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 1 Generic Rx (mail order 90 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx2_mail_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 2 Preferred Brand Rx (mail order 90 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx3_mail_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 3 Non-Preferred Brand Rx (mail order 90 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "rx4_mail_ded_apply": { "type": "string", "enum": [ "FALSE", "FALSE_COIN", "TRUE", "TRUE_COIN" ], "description": "Does the deductible and/or coinsurance apply to Tier 4 Specialty Rx (mail order 90 days)?\n\n- FALSE= Deductible and Coinsurance do not apply. \n\n- FALSE_COIN= Only Coinsurance applies. \n\n- TRUE= Only Deductible applies. \n\n- TRUE_COIN= Deductible and Coinsurance both apply." }, "pcp_copay": { "type": "integer", "description": "Single payment that applies to Primary Care Physician visits in-network. Only provide a value if a copay is required." }, "sp_copay": { "type": "integer", "description": "Single payment that applies to Specialist Physician visits in-network. Only provide a value if a copay is required." }, "er_copay": { "type": "integer", "description": "Single payment that applies to Emergency Room visits in-network. Only provide a value if a copay is required." }, "uc_copay": { "type": "integer", "description": "Single payment that applies to Urgent Care visits in-network. Only provide a value if a copay is required." }, "lx_copay": { "type": "integer", "description": "Single payment that applies to Basic Lab & X-ray services in-network. Only provide a value if a copay is required." }, "ip_copay": { "type": "integer", "description": "Single payment that applies to Inpatient Hospital visits in-network. Only provide a value if a copay is required." }, "op_copay": { "type": "integer", "description": "Single payment that applies to Outpatient Hospital visits in-network. Only provide a value if a copay is required." }, "rx1_copay": { "type": "integer", "description": "Single payment that applies to Tier 1 Generic Rx (retail 30 days) in-network. Only provide a value if a copay is required." }, "rx2_copay": { "type": "integer", "description": "Single payment that applies to Tier 2 Preferred Brand Rx (retail 30 days) in-network. Only provide a value if a copay is required." }, "rx3_copay": { "type": "integer", "description": "Single payment that applies to Tier 3 Non-Preferred Brand Rx (retail 30 days) in-network. Only provide a value if a copay is required." }, "rx4_copay": { "type": "integer", "description": "Single payment that applies to Tier 4 Specialty Rx (retail 30 days) in-network. Only provide a value if a copay is required." }, "rx1_mail_copay": { "type": "integer", "description": "Single payment that applies to Tier 1 Generic Rx (mail order 90 days) in-network. Only provide a value if a copay is required." }, "rx2_mail_copay": { "type": "integer", "description": "Single payment that applies to Tier 2 Preferred Brand Rx (mail order 90 days) in-network. Only provide a value if a copay is required." }, "rx3_mail_copay": { "type": "integer", "description": "Single payment that applies to Tier 3 Non-Preferred Brand Rx (mail order 90 days) in-network. Only provide a value if a copay is required." }, "rx4_mail_copay": { "type": "integer", "description": "Single payment that applies to Tier 4 Specialty Rx (mail order 90 days) in-network. Only provide a value if a copay is required." }, "hra": { "type": "boolean", "description": "Is an HRA offered with the Medical/Rx plan?" }, "hsa": { "type": "boolean", "description": "Is an HSA offered with the Medical/Rx plan?" }, "fsa": { "type": "boolean", "description": "Is an FSA offered with the Medical/Rx plan?" }, "age_rated": { "type": "boolean", "description": "Are the premium rates based 100% on age-banded or community ratings?" }, "salary_banding": { "type": "boolean", "description": "Do the employee contributions vary based on employee salary?" }, "tobacco_surcharge": { "type": "integer", "nullable": true, "description": "Additional amount employees are required to pay annually (PEPY) based on tested or self-reported tobacco use. If not required, set to null." }, "spousal_surcharge": { "type": "integer", "nullable": true, "description": "Additional amount employees are required to pay annually (PEPY) based on whether spouse is working/retired and is eligible for medical coverage through their employer/former employer. If not required, set to null." }, "t1_ercdhp": { "type": "integer", "nullable": true, "description": "The amount funded to single tier employees' HSA account each year by the employer" }, "t2_ercdhp": { "type": "integer", "nullable": true, "description": "The amount funded to employee + spouse tier employees' HSA account each year by the employer" }, "t3_ercdhp": { "type": "integer", "nullable": true, "description": "The amount funded to employee + children tier employees' HSA account each year by the employer" }, "t4_ercdhp": { "type": "integer", "nullable": true, "description": "The amount funded to employee + family tier employees' HSA account each year by the employer" } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "funding", "t1_ee", "t2_ee", "t3_ee", "t4_ee", "t1_gross", "t2_gross", "t3_gross", "t4_gross", "type", "in_ded_single", "in_ded_family", "in_max_single", "in_max_family", "in_coin", "pcp_ded_apply", "sp_ded_apply", "er_ded_apply", "uc_ded_apply", "lx_ded_apply", "ip_ded_apply", "op_ded_apply", "rx1_ded_apply", "rx2_ded_apply", "hra", "hsa", "fsa", "age_rated", "salary_banding", "spousal_surcharge", "tobacco_surcharge", "t1_ercdhp", "t2_ercdhp", "t3_ercdhp", "t4_ercdhp" ] } } } }, "400": { "description": "Bad request / invalid data", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "array", "description": "List of data validation errors for 'id' field.", "items": { "type": "string" } }, "employer": { "type": "array", "description": "List of data validation errors for 'employer' field.", "items": { "type": "string" } }, "title": { "type": "array", "description": "List of data validation errors for 'title' field.", "items": { "type": "string" } }, "carrier": { "type": "array", "description": "List of data validation errors for 'carrier' field.", "items": { "type": "string" } }, "start_date": { "type": "array", "description": "List of data validation errors for 'start_date' field.", "items": { "type": "string" } }, "end_date": { "type": "array", "description": "List of data validation errors for 'end_date' field.", "items": { "type": "string" } }, "from_plan": { "type": "array", "description": "List of data validation errors for 'from_plan' field.", "items": { "type": "string" } }, "from_action": { "type": "array", "description": "List of data validation errors for 'from_action' field.", "items": { "type": "string" } }, "pt": { "type": "array", "description": "List of data validation errors for 'pt' field.", "items": { "type": "string" } }, "funding": { "type": "array", "description": "List of data validation errors for 'funding' field.", "items": { "type": "string" } }, "t1_ee": { "type": "array", "description": "List of data validation errors for 't1_ee' field.", "items": { "type": "string" } }, "t2_ee": { "type": "array", "description": "List of data validation errors for 't2_ee' field.", "items": { "type": "string" } }, "t3_ee": { "type": "array", "description": "List of data validation errors for 't3_ee' field.", "items": { "type": "string" } }, "t4_ee": { "type": "array", "description": "List of data validation errors for 't4_ee' field.", "items": { "type": "string" } }, "t1_gross": { "type": "array", "description": "List of data validation errors for 't1_gross' field.", "items": { "type": "string" } }, "t2_gross": { "type": "array", "description": "List of data validation errors for 't2_gross' field.", "items": { "type": "string" } }, "t3_gross": { "type": "array", "description": "List of data validation errors for 't3_gross' field.", "items": { "type": "string" } }, "t4_gross": { "type": "array", "description": "List of data validation errors for 't4_gross' field.", "items": { "type": "string" } }, "type": { "type": "array", "description": "List of data validation errors for 'type' field.", "items": { "type": "string" } }, "in_ded_single": { "type": "array", "description": "List of data validation errors for 'in_ded_single' field.", "items": { "type": "string" } }, "in_ded_family": { "type": "array", "description": "List of data validation errors for 'in_ded_family' field.", "items": { "type": "string" } }, "in_max_single": { "type": "array", "description": "List of data validation errors for 'in_max_single' field.", "items": { "type": "string" } }, "in_max_family": { "type": "array", "description": "List of data validation errors for 'in_max_family' field.", "items": { "type": "string" } }, "in_coin": { "type": "array", "description": "List of data validation errors for 'in_coin' field.", "items": { "type": "string" } }, "out_ded_single": { "type": "array", "description": "List of data validation errors for 'out_ded_single' field.", "items": { "type": "string" } }, "out_ded_family": { "type": "array", "description": "List of data validation errors for 'out_ded_family' field.", "items": { "type": "string" } }, "out_max_single": { "type": "array", "description": "List of data validation errors for 'out_max_single' field.", "items": { "type": "string" } }, "out_max_family": { "type": "array", "description": "List of data validation errors for 'out_max_family' field.", "items": { "type": "string" } }, "out_coin": { "type": "array", "description": "List of data validation errors for 'out_coin' field.", "items": { "type": "string" } }, "rx_ded_single": { "type": "array", "description": "List of data validation errors for 'rx_ded_single' field.", "items": { "type": "string" } }, "rx_ded_family": { "type": "array", "description": "List of data validation errors for 'rx_ded_family' field.", "items": { "type": "string" } }, "rx_max_single": { "type": "array", "description": "List of data validation errors for 'rx_max_single' field.", "items": { "type": "string" } }, "rx_max_family": { "type": "array", "description": "List of data validation errors for 'rx_max_family' field.", "items": { "type": "string" } }, "rx_coin": { "type": "array", "description": "List of data validation errors for 'rx_coin' field.", "items": { "type": "string" } }, "pcp_copay": { "type": "array", "description": "List of data validation errors for 'pcp_copay' field.", "items": { "type": "string" } }, "sp_copay": { "type": "array", "description": "List of data validation errors for 'sp_copay' field.", "items": { "type": "string" } }, "er_copay": { "type": "array", "description": "List of data validation errors for 'er_copay' field.", "items": { "type": "string" } }, "uc_copay": { "type": "array", "description": "List of data validation errors for 'uc_copay' field.", "items": { "type": "string" } }, "lx_copay": { "type": "array", "description": "List of data validation errors for 'lx_copay' field.", "items": { "type": "string" } }, "ip_copay": { "type": "array", "description": "List of data validation errors for 'ip_copay' field.", "items": { "type": "string" } }, "op_copay": { "type": "array", "description": "List of data validation errors for 'op_copay' field.", "items": { "type": "string" } }, "rx1_copay": { "type": "array", "description": "List of data validation errors for 'rx1_copay' field.", "items": { "type": "string" } }, "rx2_copay": { "type": "array", "description": "List of data validation errors for 'rx2_copay' field.", "items": { "type": "string" } }, "rx3_copay": { "type": "array", "description": "List of data validation errors for 'rx3_copay' field.", "items": { "type": "string" } }, "rx4_copay": { "type": "array", "description": "List of data validation errors for 'rx4_copay' field.", "items": { "type": "string" } }, "rx1_mail_copay": { "type": "array", "description": "List of data validation errors for 'rx1_mail_copay' field.", "items": { "type": "string" } }, "rx2_mail_copay": { "type": "array", "description": "List of data validation errors for 'rx2_mail_copay' field.", "items": { "type": "string" } }, "rx3_mail_copay": { "type": "array", "description": "List of data validation errors for 'rx3_mail_copay' field.", "items": { "type": "string" } }, "rx4_mail_copay": { "type": "array", "description": "List of data validation errors for 'rx4_mail_copay' field.", "items": { "type": "string" } }, "pcp_ded_apply": { "type": "array", "description": "List of data validation errors for 'pcp_ded_apply' field.", "items": { "type": "string" } }, "sp_ded_apply": { "type": "array", "description": "List of data validation errors for 'sp_ded_apply' field.", "items": { "type": "string" } }, "er_ded_apply": { "type": "array", "description": "List of data validation errors for 'er_ded_apply' field.", "items": { "type": "string" } }, "uc_ded_apply": { "type": "array", "description": "List of data validation errors for 'uc_ded_apply' field.", "items": { "type": "string" } }, "lx_ded_apply": { "type": "array", "description": "List of data validation errors for 'lx_ded_apply' field.", "items": { "type": "string" } }, "ip_ded_apply": { "type": "array", "description": "List of data validation errors for 'ip_ded_apply' field.", "items": { "type": "string" } }, "op_ded_apply": { "type": "array", "description": "List of data validation errors for 'op_ded_apply' field.", "items": { "type": "string" } }, "rx1_ded_apply": { "type": "array", "description": "List of data validation errors for 'rx1_ded_apply' field.", "items": { "type": "string" } }, "rx2_ded_apply": { "type": "array", "description": "List of data validation errors for 'rx2_ded_apply' field.", "items": { "type": "string" } }, "rx3_ded_apply": { "type": "array", "description": "List of data validation errors for 'rx3_ded_apply' field.", "items": { "type": "string" } }, "rx4_ded_apply": { "type": "array", "description": "List of data validation errors for 'rx4_ded_apply' field.", "items": { "type": "string" } }, "rx1_mail_ded_apply": { "type": "array", "description": "List of data validation errors for 'rx1_mail_ded_apply' field.", "items": { "type": "string" } }, "rx2_mail_ded_apply": { "type": "array", "description": "List of data validation errors for 'rx2_mail_ded_apply' field.", "items": { "type": "string" } }, "rx3_mail_ded_apply": { "type": "array", "description": "List of data validation errors for 'rx3_mail_ded_apply' field.", "items": { "type": "string" } }, "rx4_mail_ded_apply": { "type": "array", "description": "List of data validation errors for 'rx4_mail_ded_apply' field.", "items": { "type": "string" } }, "hra": { "type": "array", "description": "List of data validation errors for 'hra' field.", "items": { "type": "string" } }, "hsa": { "type": "array", "description": "List of data validation errors for 'hsa' field.", "items": { "type": "string" } }, "fsa": { "type": "array", "description": "List of data validation errors for 'fsa' field.", "items": { "type": "string" } }, "age_rated": { "type": "array", "description": "List of data validation errors for 'age_rated' field.", "items": { "type": "string" } }, "salary_banding": { "type": "array", "description": "List of data validation errors for 'salary_banding' field.", "items": { "type": "string" } }, "spousal_surcharge": { "type": "array", "description": "List of data validation errors for 'spousal_surcharge' field.", "items": { "type": "string" } }, "tobacco_surcharge": { "type": "array", "description": "List of data validation errors for 'tobacco_surcharge' field.", "items": { "type": "string" } }, "t1_ercdhp": { "type": "array", "description": "List of data validation errors for 't1_ercdhp' field.", "items": { "type": "string" } }, "t2_ercdhp": { "type": "array", "description": "List of data validation errors for 't2_ercdhp' field.", "items": { "type": "string" } }, "t3_ercdhp": { "type": "array", "description": "List of data validation errors for 't3_ercdhp' field.", "items": { "type": "string" } }, "t4_ercdhp": { "type": "array", "description": "List of data validation errors for 't4_ercdhp' field.", "items": { "type": "string" } } } } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } }, "delete": { "summary": "Delete Medical Plan", "tags": [ "Medical/Rx Plans" ], "parameters": [ { "$ref": "#/components/parameters/planID" } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Success." }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/plans/dental/": { "post": { "summary": "Create Dental Plan", "tags": [ "Dental Plans" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "funding": { "type": "string", "enum": [ "FUNDING_FULLY", "FUNDING_LEVEL", "FUNDING_SELF" ], "description": "Used to differentiate plans within the benefit class based on how employer shares risk with carrier." }, "t1_ee": { "type": "integer", "description": "Amount paid by a single (tier 1) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t2_ee": { "type": "integer", "description": "Amount paid by an employee + spouse (tier 2) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_ee": { "type": "integer", "description": "Amount paid by an employee + children (tier 3) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_ee": { "type": "integer", "description": "Amount paid by an employee + family (tier 4) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t1_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover a single (tier 1) employee per year (PEPY)." }, "t2_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + spouse (tier 2) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + children (tier 3) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + family (tier 4) employee per year (PEPY)." }, "type": { "type": "string", "enum": [ "DPPO", "DMO" ], "description": "Used to differentiate plans within the benefit class based on how benefits are paid." }, "in_ded_single": { "type": "integer", "description": "The dollar amount of eligible expenses a covered single tier employee must pay each year out of pocket before the plan will make payment for eligible benefits in-network." }, "in_ded_family": { "type": "integer", "description": "The dollar amount of eligible expenses a covered family tier employee must pay each year out of pocket before the plan will make payment for eligible benefits in-network." }, "in_max": { "type": "integer", "description": "The maximum dollar amount the plan will pay per member toward the in-network cost of dental care within a calendar year." }, "in_max_ortho": { "type": "integer", "description": "The maximum dollar amount the plan will pay per member toward the in-network cost of orthodontia care in the member's lifetime." }, "out_ded_single": { "type": "integer", "description": "The dollar amount of eligible expenses a covered single tier employee must pay each year out of pocket before the plan will make payment for eligible benefits out-of-network. Required if type is set to 'DPPO'." }, "out_ded_family": { "type": "integer", "description": "The dollar amount of eligible expenses a covered family tier employee must pay each year out of pocket before the plan will make payment for eligible benefits out-of-network. Required if type is set to 'DPPO'." }, "out_max": { "type": "integer", "description": "The maximum dollar amount the plan will pay per member toward the out-of-network cost of dental care within a calendar year. Required if type is set to 'DPPO'." }, "out_max_ortho": { "type": "integer", "description": "The maximum dollar amount the plan will pay per member toward the out-of-network cost of orthodontia care in the member's lifetime." }, "prev_ded_apply": { "type": "boolean", "description": "Does the deductible apply to preventive care?" }, "basic_ded_apply": { "type": "boolean", "description": "Does the deductible apply to basic care?" }, "major_ded_apply": { "type": "boolean", "nullable": true, "description": "Does the deductible apply to major care? If major care is not covered, set to null." }, "ortho_ded_apply": { "type": "boolean", "nullable": true, "description": "Does the deductible apply to orthodontia care? If orthodontia care is not covered, set to null." }, "in_prev_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for in-network preventive care. If the service is copay-based, set to null." }, "in_basic_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for in-network basic care. If the service is copay-based, set to null." }, "in_major_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for in-network major care. If the service is copay-based, set to null." }, "in_ortho_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for in-network orthodontia care. If the service is copay-based, set to null." }, "out_prev_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for out-of-network preventive care. If the service is copay-based, set to null." }, "out_basic_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for out-of-network basic care. If the service is copay-based, set to null." }, "out_major_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for out-of-network major care. If the service is copay-based, set to null." }, "out_ortho_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for out-of-network orthodontia care. If the service is copay-based, set to null." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "funding", "t1_ee", "t2_ee", "t3_ee", "t4_ee", "t1_gross", "t2_gross", "t3_gross", "t4_gross", "type", "in_ded_single", "in_ded_family", "in_max", "prev_ded_apply", "basic_ded_apply" ] }, "examples": { "dental": { "value": { "employer": "7574457f-e9ed-4a65-8baa-72b8088b9f45", "title": "Sample Dental Plan", "carrier": "Delta Dental", "start_date": "2023-01-01", "end_date": "2023-12-31", "from_plan": "2d373e05-28cb-401a-a0f5-2e8b7c0d524c", "from_action": "RENEWED", "pt": false, "funding": "FUNDING_FULLY", "type": "DPPO", "t1_ee": 283, "t2_ee": 567, "t3_ee": 593, "t4_ee": 905, "t1_gross": 566, "t2_gross": 1133, "t3_gross": 1185, "t4_gross": 1809, "in_ded_single": 50, "in_ded_family": 150, "in_max": 1500, "in_max_ortho": 1500, "out_ded_single": 50, "out_ded_family": 150, "out_max": 1500, "out_max_ortho": 1500, "prev_ded_apply": false, "basic_ded_apply": true, "major_ded_apply": true, "ortho_ded_apply": false, "in_prev_coin": 0, "in_basic_coin": 20, "in_major_coin": 50, "in_ortho_coin": 50, "out_prev_coin": 0, "out_basic_coin": 20, "out_major_coin": 50, "out_ortho_coin": 50 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of plan." }, "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "funding": { "type": "string", "enum": [ "FUNDING_FULLY", "FUNDING_LEVEL", "FUNDING_SELF" ], "description": "Used to differentiate plans within the benefit class based on how employer shares risk with carrier." }, "t1_ee": { "type": "integer", "description": "Amount paid by a single (tier 1) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t2_ee": { "type": "integer", "description": "Amount paid by an employee + spouse (tier 2) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_ee": { "type": "integer", "description": "Amount paid by an employee + children (tier 3) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_ee": { "type": "integer", "description": "Amount paid by an employee + family (tier 4) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t1_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover a single (tier 1) employee per year (PEPY)." }, "t2_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + spouse (tier 2) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + children (tier 3) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + family (tier 4) employee per year (PEPY)." }, "type": { "type": "string", "enum": [ "DPPO", "DMO" ], "description": "Used to differentiate plans within the benefit class based on how benefits are paid." }, "in_ded_single": { "type": "integer", "description": "The dollar amount of eligible expenses a covered single tier employee must pay each year out of pocket before the plan will make payment for eligible benefits in-network." }, "in_ded_family": { "type": "integer", "description": "The dollar amount of eligible expenses a covered family tier employee must pay each year out of pocket before the plan will make payment for eligible benefits in-network." }, "in_max": { "type": "integer", "description": "The maximum dollar amount the plan will pay per member toward the in-network cost of dental care within a calendar year." }, "in_max_ortho": { "type": "integer", "description": "The maximum dollar amount the plan will pay per member toward the in-network cost of orthodontia care in the member's lifetime." }, "out_ded_single": { "type": "integer", "description": "The dollar amount of eligible expenses a covered single tier employee must pay each year out of pocket before the plan will make payment for eligible benefits out-of-network. Required if type is set to 'DPPO'." }, "out_ded_family": { "type": "integer", "description": "The dollar amount of eligible expenses a covered family tier employee must pay each year out of pocket before the plan will make payment for eligible benefits out-of-network. Required if type is set to 'DPPO'." }, "out_max": { "type": "integer", "description": "The maximum dollar amount the plan will pay per member toward the out-of-network cost of dental care within a calendar year. Required if type is set to 'DPPO'." }, "out_max_ortho": { "type": "integer", "description": "The maximum dollar amount the plan will pay per member toward the out-of-network cost of orthodontia care in the member's lifetime." }, "prev_ded_apply": { "type": "boolean", "description": "Does the deductible apply to preventive care?" }, "basic_ded_apply": { "type": "boolean", "description": "Does the deductible apply to basic care?" }, "major_ded_apply": { "type": "boolean", "nullable": true, "description": "Does the deductible apply to major care? If major care is not covered, set to null." }, "ortho_ded_apply": { "type": "boolean", "nullable": true, "description": "Does the deductible apply to orthodontia care? If orthodontia care is not covered, set to null." }, "in_prev_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for in-network preventive care. If the service is copay-based, set to null." }, "in_basic_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for in-network basic care. If the service is copay-based, set to null." }, "in_major_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for in-network major care. If the service is copay-based, set to null." }, "in_ortho_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for in-network orthodontia care. If the service is copay-based, set to null." }, "out_prev_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for out-of-network preventive care. If the service is copay-based, set to null." }, "out_basic_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for out-of-network basic care. If the service is copay-based, set to null." }, "out_major_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for out-of-network major care. If the service is copay-based, set to null." }, "out_ortho_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for out-of-network orthodontia care. If the service is copay-based, set to null." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "funding", "t1_ee", "t2_ee", "t3_ee", "t4_ee", "t1_gross", "t2_gross", "t3_gross", "t4_gross", "type", "in_ded_single", "in_ded_family", "in_max", "prev_ded_apply", "basic_ded_apply" ] } } } }, "400": { "description": "Bad request / invalid data", "content": { "application/json": { "schema": { "type": "object", "properties": { "employer": { "type": "array", "description": "List of data validation errors for 'employer' field.", "items": { "type": "string" } }, "title": { "type": "array", "description": "List of data validation errors for 'title' field.", "items": { "type": "string" } }, "carrier": { "type": "array", "description": "List of data validation errors for 'carrier' field.", "items": { "type": "string" } }, "start_date": { "type": "array", "description": "List of data validation errors for 'start_date' field.", "items": { "type": "string" } }, "end_date": { "type": "array", "description": "List of data validation errors for 'end_date' field.", "items": { "type": "string" } }, "from_plan": { "type": "array", "description": "List of data validation errors for 'from_plan' field.", "items": { "type": "string" } }, "from_action": { "type": "array", "description": "List of data validation errors for 'from_action' field.", "items": { "type": "string" } }, "pt": { "type": "array", "description": "List of data validation errors for 'pt' field.", "items": { "type": "string" } }, "funding": { "type": "array", "description": "List of data validation errors for 'funding' field.", "items": { "type": "string" } }, "t1_ee": { "type": "array", "description": "List of data validation errors for 't1_ee' field.", "items": { "type": "string" } }, "t2_ee": { "type": "array", "description": "List of data validation errors for 't2_ee' field.", "items": { "type": "string" } }, "t3_ee": { "type": "array", "description": "List of data validation errors for 't3_ee' field.", "items": { "type": "string" } }, "t4_ee": { "type": "array", "description": "List of data validation errors for 't4_ee' field.", "items": { "type": "string" } }, "t1_gross": { "type": "array", "description": "List of data validation errors for 't1_gross' field.", "items": { "type": "string" } }, "t2_gross": { "type": "array", "description": "List of data validation errors for 't2_gross' field.", "items": { "type": "string" } }, "t3_gross": { "type": "array", "description": "List of data validation errors for 't3_gross' field.", "items": { "type": "string" } }, "t4_gross": { "type": "array", "description": "List of data validation errors for 't4_gross' field.", "items": { "type": "string" } }, "type": { "type": "array", "description": "List of data validation errors for 'type' field.", "items": { "type": "string" } }, "in_ded_single": { "type": "array", "description": "List of data validation errors for 'in_ded_single' field.", "items": { "type": "string" } }, "in_ded_family": { "type": "array", "description": "List of data validation errors for 'in_ded_family' field.", "items": { "type": "string" } }, "in_max": { "type": "array", "description": "List of data validation errors for 'in_max' field.", "items": { "type": "string" } }, "in_max_ortho": { "type": "array", "description": "List of data validation errors for 'in_max_ortho' field.", "items": { "type": "string" } }, "out_ded_single": { "type": "array", "description": "List of data validation errors for 'out_ded_single' field.", "items": { "type": "string" } }, "out_ded_family": { "type": "array", "description": "List of data validation errors for 'out_ded_family' field.", "items": { "type": "string" } }, "out_max": { "type": "array", "description": "List of data validation errors for 'out_max' field.", "items": { "type": "string" } }, "out_max_ortho": { "type": "array", "description": "List of data validation errors for 'out_max_ortho' field.", "items": { "type": "string" } }, "prev_ded_apply": { "type": "array", "description": "List of data validation errors for 'prev_ded_apply' field.", "items": { "type": "string" } }, "basic_ded_apply": { "type": "array", "description": "List of data validation errors for 'basic_ded_apply' field.", "items": { "type": "string" } }, "major_ded_apply": { "type": "array", "description": "List of data validation errors for 'major_ded_apply' field.", "items": { "type": "string" } }, "ortho_ded_apply": { "type": "array", "description": "List of data validation errors for 'ortho_ded_apply' field.", "items": { "type": "string" } }, "in_prev_coin": { "type": "array", "description": "List of data validation errors for 'in_prev_coin' field.", "items": { "type": "string" } }, "in_basic_coin": { "type": "array", "description": "List of data validation errors for 'in_basic_coin' field.", "items": { "type": "string" } }, "in_major_coin": { "type": "array", "description": "List of data validation errors for 'in_major_coin' field.", "items": { "type": "string" } }, "in_ortho_coin": { "type": "array", "description": "List of data validation errors for 'in_ortho_coin' field.", "items": { "type": "string" } }, "out_prev_coin": { "type": "array", "description": "List of data validation errors for 'out_prev_coin' field.", "items": { "type": "string" } }, "out_basic_coin": { "type": "array", "description": "List of data validation errors for 'out_basic_coin' field.", "items": { "type": "string" } }, "out_major_coin": { "type": "array", "description": "List of data validation errors for 'out_major_coin' field.", "items": { "type": "string" } }, "out_ortho_coin": { "type": "array", "description": "List of data validation errors for 'out_ortho_coin' field.", "items": { "type": "string" } } } } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/plans/dental/{planID}/": { "get": { "summary": "Get Dental Plan", "tags": [ "Dental Plans" ], "parameters": [ { "$ref": "#/components/parameters/planID" } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of plan." }, "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "funding": { "type": "string", "enum": [ "FUNDING_FULLY", "FUNDING_LEVEL", "FUNDING_SELF" ], "description": "Used to differentiate plans within the benefit class based on how employer shares risk with carrier." }, "t1_ee": { "type": "integer", "description": "Amount paid by a single (tier 1) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t2_ee": { "type": "integer", "description": "Amount paid by an employee + spouse (tier 2) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_ee": { "type": "integer", "description": "Amount paid by an employee + children (tier 3) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_ee": { "type": "integer", "description": "Amount paid by an employee + family (tier 4) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t1_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover a single (tier 1) employee per year (PEPY)." }, "t2_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + spouse (tier 2) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + children (tier 3) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + family (tier 4) employee per year (PEPY)." }, "type": { "type": "string", "enum": [ "DPPO", "DMO" ], "description": "Used to differentiate plans within the benefit class based on how benefits are paid." }, "in_ded_single": { "type": "integer", "description": "The dollar amount of eligible expenses a covered single tier employee must pay each year out of pocket before the plan will make payment for eligible benefits in-network." }, "in_ded_family": { "type": "integer", "description": "The dollar amount of eligible expenses a covered family tier employee must pay each year out of pocket before the plan will make payment for eligible benefits in-network." }, "in_max": { "type": "integer", "description": "The maximum dollar amount the plan will pay per member toward the in-network cost of dental care within a calendar year." }, "in_max_ortho": { "type": "integer", "description": "The maximum dollar amount the plan will pay per member toward the in-network cost of orthodontia care in the member's lifetime." }, "out_ded_single": { "type": "integer", "description": "The dollar amount of eligible expenses a covered single tier employee must pay each year out of pocket before the plan will make payment for eligible benefits out-of-network. Required if type is set to 'DPPO'." }, "out_ded_family": { "type": "integer", "description": "The dollar amount of eligible expenses a covered family tier employee must pay each year out of pocket before the plan will make payment for eligible benefits out-of-network. Required if type is set to 'DPPO'." }, "out_max": { "type": "integer", "description": "The maximum dollar amount the plan will pay per member toward the out-of-network cost of dental care within a calendar year. Required if type is set to 'DPPO'." }, "out_max_ortho": { "type": "integer", "description": "The maximum dollar amount the plan will pay per member toward the out-of-network cost of orthodontia care in the member's lifetime." }, "prev_ded_apply": { "type": "boolean", "description": "Does the deductible apply to preventive care?" }, "basic_ded_apply": { "type": "boolean", "description": "Does the deductible apply to basic care?" }, "major_ded_apply": { "type": "boolean", "nullable": true, "description": "Does the deductible apply to major care? If major care is not covered, set to null." }, "ortho_ded_apply": { "type": "boolean", "nullable": true, "description": "Does the deductible apply to orthodontia care? If orthodontia care is not covered, set to null." }, "in_prev_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for in-network preventive care. If the service is copay-based, set to null." }, "in_basic_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for in-network basic care. If the service is copay-based, set to null." }, "in_major_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for in-network major care. If the service is copay-based, set to null." }, "in_ortho_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for in-network orthodontia care. If the service is copay-based, set to null." }, "out_prev_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for out-of-network preventive care. If the service is copay-based, set to null." }, "out_basic_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for out-of-network basic care. If the service is copay-based, set to null." }, "out_major_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for out-of-network major care. If the service is copay-based, set to null." }, "out_ortho_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for out-of-network orthodontia care. If the service is copay-based, set to null." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "funding", "t1_ee", "t2_ee", "t3_ee", "t4_ee", "t1_gross", "t2_gross", "t3_gross", "t4_gross", "type", "in_ded_single", "in_ded_family", "in_max", "prev_ded_apply", "basic_ded_apply" ] } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } }, "put": { "summary": "Update Dental Plan", "tags": [ "Dental Plans" ], "parameters": [ { "$ref": "#/components/parameters/planID" } ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "funding": { "type": "string", "enum": [ "FUNDING_FULLY", "FUNDING_LEVEL", "FUNDING_SELF" ], "description": "Used to differentiate plans within the benefit class based on how employer shares risk with carrier." }, "t1_ee": { "type": "integer", "description": "Amount paid by a single (tier 1) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t2_ee": { "type": "integer", "description": "Amount paid by an employee + spouse (tier 2) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_ee": { "type": "integer", "description": "Amount paid by an employee + children (tier 3) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_ee": { "type": "integer", "description": "Amount paid by an employee + family (tier 4) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t1_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover a single (tier 1) employee per year (PEPY)." }, "t2_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + spouse (tier 2) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + children (tier 3) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + family (tier 4) employee per year (PEPY)." }, "type": { "type": "string", "enum": [ "DPPO", "DMO" ], "description": "Used to differentiate plans within the benefit class based on how benefits are paid." }, "in_ded_single": { "type": "integer", "description": "The dollar amount of eligible expenses a covered single tier employee must pay each year out of pocket before the plan will make payment for eligible benefits in-network." }, "in_ded_family": { "type": "integer", "description": "The dollar amount of eligible expenses a covered family tier employee must pay each year out of pocket before the plan will make payment for eligible benefits in-network." }, "in_max": { "type": "integer", "description": "The maximum dollar amount the plan will pay per member toward the in-network cost of dental care within a calendar year." }, "in_max_ortho": { "type": "integer", "description": "The maximum dollar amount the plan will pay per member toward the in-network cost of orthodontia care in the member's lifetime." }, "out_ded_single": { "type": "integer", "description": "The dollar amount of eligible expenses a covered single tier employee must pay each year out of pocket before the plan will make payment for eligible benefits out-of-network. Required if type is set to 'DPPO'." }, "out_ded_family": { "type": "integer", "description": "The dollar amount of eligible expenses a covered family tier employee must pay each year out of pocket before the plan will make payment for eligible benefits out-of-network. Required if type is set to 'DPPO'." }, "out_max": { "type": "integer", "description": "The maximum dollar amount the plan will pay per member toward the out-of-network cost of dental care within a calendar year. Required if type is set to 'DPPO'." }, "out_max_ortho": { "type": "integer", "description": "The maximum dollar amount the plan will pay per member toward the out-of-network cost of orthodontia care in the member's lifetime." }, "prev_ded_apply": { "type": "boolean", "description": "Does the deductible apply to preventive care?" }, "basic_ded_apply": { "type": "boolean", "description": "Does the deductible apply to basic care?" }, "major_ded_apply": { "type": "boolean", "nullable": true, "description": "Does the deductible apply to major care? If major care is not covered, set to null." }, "ortho_ded_apply": { "type": "boolean", "nullable": true, "description": "Does the deductible apply to orthodontia care? If orthodontia care is not covered, set to null." }, "in_prev_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for in-network preventive care. If the service is copay-based, set to null." }, "in_basic_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for in-network basic care. If the service is copay-based, set to null." }, "in_major_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for in-network major care. If the service is copay-based, set to null." }, "in_ortho_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for in-network orthodontia care. If the service is copay-based, set to null." }, "out_prev_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for out-of-network preventive care. If the service is copay-based, set to null." }, "out_basic_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for out-of-network basic care. If the service is copay-based, set to null." }, "out_major_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for out-of-network major care. If the service is copay-based, set to null." }, "out_ortho_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for out-of-network orthodontia care. If the service is copay-based, set to null." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "funding", "t1_ee", "t2_ee", "t3_ee", "t4_ee", "t1_gross", "t2_gross", "t3_gross", "t4_gross", "type", "in_ded_single", "in_ded_family", "in_max", "prev_ded_apply", "basic_ded_apply" ] }, "examples": { "dental": { "value": { "employer": "7574457f-e9ed-4a65-8baa-72b8088b9f45", "title": "Sample Dental Plan", "carrier": "Delta Dental", "start_date": "2023-01-01", "end_date": "2023-12-31", "from_plan": "2d373e05-28cb-401a-a0f5-2e8b7c0d524c", "from_action": "RENEWED", "pt": false, "funding": "FUNDING_FULLY", "type": "DPPO", "t1_ee": 283, "t2_ee": 567, "t3_ee": 593, "t4_ee": 905, "t1_gross": 566, "t2_gross": 1133, "t3_gross": 1185, "t4_gross": 1809, "in_ded_single": 50, "in_ded_family": 150, "in_max": 1500, "in_max_ortho": 1500, "out_ded_single": 50, "out_ded_family": 150, "out_max": 1500, "out_max_ortho": 1500, "prev_ded_apply": false, "basic_ded_apply": true, "major_ded_apply": true, "ortho_ded_apply": false, "in_prev_coin": 0, "in_basic_coin": 20, "in_major_coin": 50, "in_ortho_coin": 50, "out_prev_coin": 0, "out_basic_coin": 20, "out_major_coin": 50, "out_ortho_coin": 50 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of plan." }, "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "funding": { "type": "string", "enum": [ "FUNDING_FULLY", "FUNDING_LEVEL", "FUNDING_SELF" ], "description": "Used to differentiate plans within the benefit class based on how employer shares risk with carrier." }, "t1_ee": { "type": "integer", "description": "Amount paid by a single (tier 1) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t2_ee": { "type": "integer", "description": "Amount paid by an employee + spouse (tier 2) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_ee": { "type": "integer", "description": "Amount paid by an employee + children (tier 3) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_ee": { "type": "integer", "description": "Amount paid by an employee + family (tier 4) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t1_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover a single (tier 1) employee per year (PEPY)." }, "t2_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + spouse (tier 2) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + children (tier 3) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + family (tier 4) employee per year (PEPY)." }, "type": { "type": "string", "enum": [ "DPPO", "DMO" ], "description": "Used to differentiate plans within the benefit class based on how benefits are paid." }, "in_ded_single": { "type": "integer", "description": "The dollar amount of eligible expenses a covered single tier employee must pay each year out of pocket before the plan will make payment for eligible benefits in-network." }, "in_ded_family": { "type": "integer", "description": "The dollar amount of eligible expenses a covered family tier employee must pay each year out of pocket before the plan will make payment for eligible benefits in-network." }, "in_max": { "type": "integer", "description": "The maximum dollar amount the plan will pay per member toward the in-network cost of dental care within a calendar year." }, "in_max_ortho": { "type": "integer", "description": "The maximum dollar amount the plan will pay per member toward the in-network cost of orthodontia care in the member's lifetime." }, "out_ded_single": { "type": "integer", "description": "The dollar amount of eligible expenses a covered single tier employee must pay each year out of pocket before the plan will make payment for eligible benefits out-of-network. Required if type is set to 'DPPO'." }, "out_ded_family": { "type": "integer", "description": "The dollar amount of eligible expenses a covered family tier employee must pay each year out of pocket before the plan will make payment for eligible benefits out-of-network. Required if type is set to 'DPPO'." }, "out_max": { "type": "integer", "description": "The maximum dollar amount the plan will pay per member toward the out-of-network cost of dental care within a calendar year. Required if type is set to 'DPPO'." }, "out_max_ortho": { "type": "integer", "description": "The maximum dollar amount the plan will pay per member toward the out-of-network cost of orthodontia care in the member's lifetime." }, "prev_ded_apply": { "type": "boolean", "description": "Does the deductible apply to preventive care?" }, "basic_ded_apply": { "type": "boolean", "description": "Does the deductible apply to basic care?" }, "major_ded_apply": { "type": "boolean", "nullable": true, "description": "Does the deductible apply to major care? If major care is not covered, set to null." }, "ortho_ded_apply": { "type": "boolean", "nullable": true, "description": "Does the deductible apply to orthodontia care? If orthodontia care is not covered, set to null." }, "in_prev_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for in-network preventive care. If the service is copay-based, set to null." }, "in_basic_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for in-network basic care. If the service is copay-based, set to null." }, "in_major_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for in-network major care. If the service is copay-based, set to null." }, "in_ortho_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for in-network orthodontia care. If the service is copay-based, set to null." }, "out_prev_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for out-of-network preventive care. If the service is copay-based, set to null." }, "out_basic_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for out-of-network basic care. If the service is copay-based, set to null." }, "out_major_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for out-of-network major care. If the service is copay-based, set to null." }, "out_ortho_coin": { "type": "integer", "nullable": true, "description": "The percentage amount that the employee is expected to cover for out-of-network orthodontia care. If the service is copay-based, set to null." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "funding", "t1_ee", "t2_ee", "t3_ee", "t4_ee", "t1_gross", "t2_gross", "t3_gross", "t4_gross", "type", "in_ded_single", "in_ded_family", "in_max", "prev_ded_apply", "basic_ded_apply" ] } } } }, "400": { "description": "Bad request / invalid data", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "array", "description": "List of data validation errors for 'id' field.", "items": { "type": "string" } }, "employer": { "type": "array", "description": "List of data validation errors for 'employer' field.", "items": { "type": "string" } }, "title": { "type": "array", "description": "List of data validation errors for 'title' field.", "items": { "type": "string" } }, "carrier": { "type": "array", "description": "List of data validation errors for 'carrier' field.", "items": { "type": "string" } }, "start_date": { "type": "array", "description": "List of data validation errors for 'start_date' field.", "items": { "type": "string" } }, "end_date": { "type": "array", "description": "List of data validation errors for 'end_date' field.", "items": { "type": "string" } }, "from_plan": { "type": "array", "description": "List of data validation errors for 'from_plan' field.", "items": { "type": "string" } }, "from_action": { "type": "array", "description": "List of data validation errors for 'from_action' field.", "items": { "type": "string" } }, "pt": { "type": "array", "description": "List of data validation errors for 'pt' field.", "items": { "type": "string" } }, "funding": { "type": "array", "description": "List of data validation errors for 'funding' field.", "items": { "type": "string" } }, "t1_ee": { "type": "array", "description": "List of data validation errors for 't1_ee' field.", "items": { "type": "string" } }, "t2_ee": { "type": "array", "description": "List of data validation errors for 't2_ee' field.", "items": { "type": "string" } }, "t3_ee": { "type": "array", "description": "List of data validation errors for 't3_ee' field.", "items": { "type": "string" } }, "t4_ee": { "type": "array", "description": "List of data validation errors for 't4_ee' field.", "items": { "type": "string" } }, "t1_gross": { "type": "array", "description": "List of data validation errors for 't1_gross' field.", "items": { "type": "string" } }, "t2_gross": { "type": "array", "description": "List of data validation errors for 't2_gross' field.", "items": { "type": "string" } }, "t3_gross": { "type": "array", "description": "List of data validation errors for 't3_gross' field.", "items": { "type": "string" } }, "t4_gross": { "type": "array", "description": "List of data validation errors for 't4_gross' field.", "items": { "type": "string" } }, "type": { "type": "array", "description": "List of data validation errors for 'type' field.", "items": { "type": "string" } }, "in_ded_single": { "type": "array", "description": "List of data validation errors for 'in_ded_single' field.", "items": { "type": "string" } }, "in_ded_family": { "type": "array", "description": "List of data validation errors for 'in_ded_family' field.", "items": { "type": "string" } }, "in_max": { "type": "array", "description": "List of data validation errors for 'in_max' field.", "items": { "type": "string" } }, "in_max_ortho": { "type": "array", "description": "List of data validation errors for 'in_max_ortho' field.", "items": { "type": "string" } }, "out_ded_single": { "type": "array", "description": "List of data validation errors for 'out_ded_single' field.", "items": { "type": "string" } }, "out_ded_family": { "type": "array", "description": "List of data validation errors for 'out_ded_family' field.", "items": { "type": "string" } }, "out_max": { "type": "array", "description": "List of data validation errors for 'out_max' field.", "items": { "type": "string" } }, "out_max_ortho": { "type": "array", "description": "List of data validation errors for 'out_max_ortho' field.", "items": { "type": "string" } }, "prev_ded_apply": { "type": "array", "description": "List of data validation errors for 'prev_ded_apply' field.", "items": { "type": "string" } }, "basic_ded_apply": { "type": "array", "description": "List of data validation errors for 'basic_ded_apply' field.", "items": { "type": "string" } }, "major_ded_apply": { "type": "array", "description": "List of data validation errors for 'major_ded_apply' field.", "items": { "type": "string" } }, "ortho_ded_apply": { "type": "array", "description": "List of data validation errors for 'ortho_ded_apply' field.", "items": { "type": "string" } }, "in_prev_coin": { "type": "array", "description": "List of data validation errors for 'in_prev_coin' field.", "items": { "type": "string" } }, "in_basic_coin": { "type": "array", "description": "List of data validation errors for 'in_basic_coin' field.", "items": { "type": "string" } }, "in_major_coin": { "type": "array", "description": "List of data validation errors for 'in_major_coin' field.", "items": { "type": "string" } }, "in_ortho_coin": { "type": "array", "description": "List of data validation errors for 'in_ortho_coin' field.", "items": { "type": "string" } }, "out_prev_coin": { "type": "array", "description": "List of data validation errors for 'out_prev_coin' field.", "items": { "type": "string" } }, "out_basic_coin": { "type": "array", "description": "List of data validation errors for 'out_basic_coin' field.", "items": { "type": "string" } }, "out_major_coin": { "type": "array", "description": "List of data validation errors for 'out_major_coin' field.", "items": { "type": "string" } }, "out_ortho_coin": { "type": "array", "description": "List of data validation errors for 'out_ortho_coin' field.", "items": { "type": "string" } } } } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } }, "delete": { "summary": "Delete Dental Plan", "tags": [ "Dental Plans" ], "parameters": [ { "$ref": "#/components/parameters/planID" } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Success." }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/plans/vision/": { "post": { "summary": "Create Vision Plan", "tags": [ "Vision Plans" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "funding": { "type": "string", "enum": [ "FUNDING_FULLY", "FUNDING_LEVEL", "FUNDING_SELF" ], "description": "Used to differentiate plans within the benefit class based on how employer shares risk with carrier." }, "t1_ee": { "type": "integer", "description": "Amount paid by a single (tier 1) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t2_ee": { "type": "integer", "description": "Amount paid by an employee + spouse (tier 2) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_ee": { "type": "integer", "description": "Amount paid by an employee + children (tier 3) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_ee": { "type": "integer", "description": "Amount paid by an employee + family (tier 4) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t1_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover a single (tier 1) employee per year (PEPY)." }, "t2_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + spouse (tier 2) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + children (tier 3) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + family (tier 4) employee per year (PEPY)." }, "exam_frequency": { "type": "integer", "description": "How often the exam benefit is covered, in months." }, "lenses_frequency": { "type": "integer", "description": "How often the lenses benefit is covered, in months." }, "frames_frequency": { "type": "integer", "description": "How often the frames benefit is covered, in months." }, "contacts_frequency": { "type": "integer", "description": "How often the contacts benefit is covered, in months." }, "exam_copay": { "type": "integer", "nullable": true, "description": "Single payment that applies to exam in-network. Only provide a value if a copay is required; otherwise set to null." }, "lenses_copay": { "type": "integer", "nullable": true, "description": "Single payment that applies to lenses in-network. Only provide a value if a copay is required; otherwise set to null." }, "frames_copay": { "type": "integer", "nullable": true, "description": "Single payment that applies to frames in-network. Only provide a value if a copay is required; otherwise set to null." }, "contacts_copay": { "type": "integer", "nullable": true, "description": "Single payment that applies to contacts in-network. Only provide a value if a copay is required; otherwise set to null." }, "exam_allowance": { "type": "integer", "nullable": true, "description": "Amount covered by insurance that applies to exam in-network. Only provide a value if an allowance is part of the cost share; otherwise set to null." }, "lenses_allowance": { "type": "integer", "nullable": true, "description": "Amount covered by insurance that applies to lenses in-network. Only provide a value if an allowance is part of the cost share; otherwise set to null." }, "frames_allowance": { "type": "integer", "nullable": true, "description": "Amount covered by insurance that applies to frames in-network. Only provide a value if an allowance is part of the cost share; otherwise set to null." }, "contacts_allowance": { "type": "integer", "nullable": true, "description": "Amount covered by insurance that applies to contacts in-network. Only provide a value if an allowance is part of the cost share; otherwise set to null." }, "exam_out_allowance": { "type": "integer", "description": "Amount covered by insurance that applies to exam out-of-network." }, "lenses_out_allowance": { "type": "integer", "description": "Amount covered by insurance that applies to lenses out-of-network." }, "frames_out_allowance": { "type": "integer", "description": "Amount covered by insurance that applies to frames out-of-network." }, "contacts_out_allowance": { "type": "integer", "description": "Amount covered by insurance that applies to contacts out-of-network." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "funding", "t1_ee", "t2_ee", "t3_ee", "t4_ee", "t1_gross", "t2_gross", "t3_gross", "t4_gross", "exam_frequency", "lenses_frequency", "frames_frequency", "contacts_frequency" ] }, "examples": { "vision": { "value": { "employer": "7574457f-e9ed-4a65-8baa-72b8088b9f45", "title": "Sample Vision Plan", "carrier": "VSP", "start_date": "2023-01-01", "end_date": "2023-12-31", "from_plan": "837f56e4-cd62-4749-91be-acb043070cc4", "from_action": "RENEWED", "pt": false, "funding": "FUNDING_FULLY", "t1_ee": 85, "t2_ee": 150, "t3_ee": 144, "t4_ee": 235, "t1_gross": 85, "t2_gross": 150, "t3_gross": 144, "t4_gross": 235, "exam_frequency": 12, "lenses_frequency": 12, "frames_frequency": 24, "contacts_frequency": 12, "exam_copay": 10, "lenses_copay": 15, "frames_copay": null, "contacts_copay": null, "exam_allowance": null, "lenses_allowance": null, "frames_allowance": 180, "contacts_allowance": 180, "exam_out_allowance": 45, "lenses_out_allowance": 32, "frames_out_allowance": 44, "contacts_out_allowance": 105 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of plan." }, "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "funding": { "type": "string", "enum": [ "FUNDING_FULLY", "FUNDING_LEVEL", "FUNDING_SELF" ], "description": "Used to differentiate plans within the benefit class based on how employer shares risk with carrier." }, "t1_ee": { "type": "integer", "description": "Amount paid by a single (tier 1) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t2_ee": { "type": "integer", "description": "Amount paid by an employee + spouse (tier 2) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_ee": { "type": "integer", "description": "Amount paid by an employee + children (tier 3) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_ee": { "type": "integer", "description": "Amount paid by an employee + family (tier 4) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t1_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover a single (tier 1) employee per year (PEPY)." }, "t2_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + spouse (tier 2) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + children (tier 3) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + family (tier 4) employee per year (PEPY)." }, "exam_frequency": { "type": "integer", "description": "How often the exam benefit is covered, in months." }, "lenses_frequency": { "type": "integer", "description": "How often the lenses benefit is covered, in months." }, "frames_frequency": { "type": "integer", "description": "How often the frames benefit is covered, in months." }, "contacts_frequency": { "type": "integer", "description": "How often the contacts benefit is covered, in months." }, "exam_copay": { "type": "integer", "nullable": true, "description": "Single payment that applies to exam in-network. Only provide a value if a copay is required; otherwise set to null." }, "lenses_copay": { "type": "integer", "nullable": true, "description": "Single payment that applies to lenses in-network. Only provide a value if a copay is required; otherwise set to null." }, "frames_copay": { "type": "integer", "nullable": true, "description": "Single payment that applies to frames in-network. Only provide a value if a copay is required; otherwise set to null." }, "contacts_copay": { "type": "integer", "nullable": true, "description": "Single payment that applies to contacts in-network. Only provide a value if a copay is required; otherwise set to null." }, "exam_allowance": { "type": "integer", "nullable": true, "description": "Amount covered by insurance that applies to exam in-network. Only provide a value if an allowance is part of the cost share; otherwise set to null." }, "lenses_allowance": { "type": "integer", "nullable": true, "description": "Amount covered by insurance that applies to lenses in-network. Only provide a value if an allowance is part of the cost share; otherwise set to null." }, "frames_allowance": { "type": "integer", "nullable": true, "description": "Amount covered by insurance that applies to frames in-network. Only provide a value if an allowance is part of the cost share; otherwise set to null." }, "contacts_allowance": { "type": "integer", "nullable": true, "description": "Amount covered by insurance that applies to contacts in-network. Only provide a value if an allowance is part of the cost share; otherwise set to null." }, "exam_out_allowance": { "type": "integer", "description": "Amount covered by insurance that applies to exam out-of-network." }, "lenses_out_allowance": { "type": "integer", "description": "Amount covered by insurance that applies to lenses out-of-network." }, "frames_out_allowance": { "type": "integer", "description": "Amount covered by insurance that applies to frames out-of-network." }, "contacts_out_allowance": { "type": "integer", "description": "Amount covered by insurance that applies to contacts out-of-network." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "funding", "t1_ee", "t2_ee", "t3_ee", "t4_ee", "t1_gross", "t2_gross", "t3_gross", "t4_gross", "exam_frequency", "lenses_frequency", "frames_frequency", "contacts_frequency" ] } } } }, "400": { "description": "Bad request / invalid data", "content": { "application/json": { "schema": { "type": "object", "properties": { "employer": { "type": "array", "description": "List of data validation errors for 'employer' field.", "items": { "type": "string" } }, "title": { "type": "array", "description": "List of data validation errors for 'title' field.", "items": { "type": "string" } }, "carrier": { "type": "array", "description": "List of data validation errors for 'carrier' field.", "items": { "type": "string" } }, "start_date": { "type": "array", "description": "List of data validation errors for 'start_date' field.", "items": { "type": "string" } }, "end_date": { "type": "array", "description": "List of data validation errors for 'end_date' field.", "items": { "type": "string" } }, "from_plan": { "type": "array", "description": "List of data validation errors for 'from_plan' field.", "items": { "type": "string" } }, "from_action": { "type": "array", "description": "List of data validation errors for 'from_action' field.", "items": { "type": "string" } }, "pt": { "type": "array", "description": "List of data validation errors for 'pt' field.", "items": { "type": "string" } }, "funding": { "type": "array", "description": "List of data validation errors for 'funding' field.", "items": { "type": "string" } }, "t1_ee": { "type": "array", "description": "List of data validation errors for 't1_ee' field.", "items": { "type": "string" } }, "t2_ee": { "type": "array", "description": "List of data validation errors for 't2_ee' field.", "items": { "type": "string" } }, "t3_ee": { "type": "array", "description": "List of data validation errors for 't3_ee' field.", "items": { "type": "string" } }, "t4_ee": { "type": "array", "description": "List of data validation errors for 't4_ee' field.", "items": { "type": "string" } }, "t1_gross": { "type": "array", "description": "List of data validation errors for 't1_gross' field.", "items": { "type": "string" } }, "t2_gross": { "type": "array", "description": "List of data validation errors for 't2_gross' field.", "items": { "type": "string" } }, "t3_gross": { "type": "array", "description": "List of data validation errors for 't3_gross' field.", "items": { "type": "string" } }, "t4_gross": { "type": "array", "description": "List of data validation errors for 't4_gross' field.", "items": { "type": "string" } }, "exam_frequency": { "type": "array", "description": "List of data validation errors for 'exam_frequency' field.", "items": { "type": "string" } }, "lenses_frequency": { "type": "array", "description": "List of data validation errors for 'lenses_frequency' field.", "items": { "type": "string" } }, "frames_frequency": { "type": "array", "description": "List of data validation errors for 'frames_frequency' field.", "items": { "type": "string" } }, "contacts_frequency": { "type": "array", "description": "List of data validation errors for 'contacts_frequency' field.", "items": { "type": "string" } }, "exam_copay": { "type": "array", "description": "List of data validation errors for 'exam_copay' field.", "items": { "type": "string" } }, "lenses_copay": { "type": "array", "description": "List of data validation errors for 'lenses_copay' field.", "items": { "type": "string" } }, "frames_copay": { "type": "array", "description": "List of data validation errors for 'frames_copay' field.", "items": { "type": "string" } }, "contacts_copay": { "type": "array", "description": "List of data validation errors for 'contacts_copay' field.", "items": { "type": "string" } }, "exam_allowance": { "type": "array", "description": "List of data validation errors for 'exam_allowance' field.", "items": { "type": "string" } }, "lenses_allowance": { "type": "array", "description": "List of data validation errors for 'lenses_allowance' field.", "items": { "type": "string" } }, "frames_allowance": { "type": "array", "description": "List of data validation errors for 'frames_allowance' field.", "items": { "type": "string" } }, "contacts_allowance": { "type": "array", "description": "List of data validation errors for 'contacts_allowance' field.", "items": { "type": "string" } }, "exam_out_allowance": { "type": "array", "description": "List of data validation errors for 'exam_out_allowance' field.", "items": { "type": "string" } }, "lenses_out_allowance": { "type": "array", "description": "List of data validation errors for 'lenses_out_allowance' field.", "items": { "type": "string" } }, "frames_out_allowance": { "type": "array", "description": "List of data validation errors for 'frames_out_allowance' field.", "items": { "type": "string" } }, "contacts_out_allowance": { "type": "array", "description": "List of data validation errors for 'contacts_out_allowance' field.", "items": { "type": "string" } } } } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/plans/vision/{planID}/": { "get": { "summary": "Get Vision Plan", "tags": [ "Vision Plans" ], "parameters": [ { "$ref": "#/components/parameters/planID" } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of plan." }, "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "funding": { "type": "string", "enum": [ "FUNDING_FULLY", "FUNDING_LEVEL", "FUNDING_SELF" ], "description": "Used to differentiate plans within the benefit class based on how employer shares risk with carrier." }, "t1_ee": { "type": "integer", "description": "Amount paid by a single (tier 1) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t2_ee": { "type": "integer", "description": "Amount paid by an employee + spouse (tier 2) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_ee": { "type": "integer", "description": "Amount paid by an employee + children (tier 3) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_ee": { "type": "integer", "description": "Amount paid by an employee + family (tier 4) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t1_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover a single (tier 1) employee per year (PEPY)." }, "t2_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + spouse (tier 2) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + children (tier 3) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + family (tier 4) employee per year (PEPY)." }, "exam_frequency": { "type": "integer", "description": "How often the exam benefit is covered, in months." }, "lenses_frequency": { "type": "integer", "description": "How often the lenses benefit is covered, in months." }, "frames_frequency": { "type": "integer", "description": "How often the frames benefit is covered, in months." }, "contacts_frequency": { "type": "integer", "description": "How often the contacts benefit is covered, in months." }, "exam_copay": { "type": "integer", "nullable": true, "description": "Single payment that applies to exam in-network. Only provide a value if a copay is required; otherwise set to null." }, "lenses_copay": { "type": "integer", "nullable": true, "description": "Single payment that applies to lenses in-network. Only provide a value if a copay is required; otherwise set to null." }, "frames_copay": { "type": "integer", "nullable": true, "description": "Single payment that applies to frames in-network. Only provide a value if a copay is required; otherwise set to null." }, "contacts_copay": { "type": "integer", "nullable": true, "description": "Single payment that applies to contacts in-network. Only provide a value if a copay is required; otherwise set to null." }, "exam_allowance": { "type": "integer", "nullable": true, "description": "Amount covered by insurance that applies to exam in-network. Only provide a value if an allowance is part of the cost share; otherwise set to null." }, "lenses_allowance": { "type": "integer", "nullable": true, "description": "Amount covered by insurance that applies to lenses in-network. Only provide a value if an allowance is part of the cost share; otherwise set to null." }, "frames_allowance": { "type": "integer", "nullable": true, "description": "Amount covered by insurance that applies to frames in-network. Only provide a value if an allowance is part of the cost share; otherwise set to null." }, "contacts_allowance": { "type": "integer", "nullable": true, "description": "Amount covered by insurance that applies to contacts in-network. Only provide a value if an allowance is part of the cost share; otherwise set to null." }, "exam_out_allowance": { "type": "integer", "description": "Amount covered by insurance that applies to exam out-of-network." }, "lenses_out_allowance": { "type": "integer", "description": "Amount covered by insurance that applies to lenses out-of-network." }, "frames_out_allowance": { "type": "integer", "description": "Amount covered by insurance that applies to frames out-of-network." }, "contacts_out_allowance": { "type": "integer", "description": "Amount covered by insurance that applies to contacts out-of-network." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "funding", "t1_ee", "t2_ee", "t3_ee", "t4_ee", "t1_gross", "t2_gross", "t3_gross", "t4_gross", "exam_frequency", "lenses_frequency", "frames_frequency", "contacts_frequency" ] } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } }, "put": { "summary": "Update Vision Plan", "tags": [ "Vision Plans" ], "parameters": [ { "$ref": "#/components/parameters/planID" } ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "funding": { "type": "string", "enum": [ "FUNDING_FULLY", "FUNDING_LEVEL", "FUNDING_SELF" ], "description": "Used to differentiate plans within the benefit class based on how employer shares risk with carrier." }, "t1_ee": { "type": "integer", "description": "Amount paid by a single (tier 1) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t2_ee": { "type": "integer", "description": "Amount paid by an employee + spouse (tier 2) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_ee": { "type": "integer", "description": "Amount paid by an employee + children (tier 3) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_ee": { "type": "integer", "description": "Amount paid by an employee + family (tier 4) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t1_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover a single (tier 1) employee per year (PEPY)." }, "t2_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + spouse (tier 2) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + children (tier 3) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + family (tier 4) employee per year (PEPY)." }, "exam_frequency": { "type": "integer", "description": "How often the exam benefit is covered, in months." }, "lenses_frequency": { "type": "integer", "description": "How often the lenses benefit is covered, in months." }, "frames_frequency": { "type": "integer", "description": "How often the frames benefit is covered, in months." }, "contacts_frequency": { "type": "integer", "description": "How often the contacts benefit is covered, in months." }, "exam_copay": { "type": "integer", "nullable": true, "description": "Single payment that applies to exam in-network. Only provide a value if a copay is required; otherwise set to null." }, "lenses_copay": { "type": "integer", "nullable": true, "description": "Single payment that applies to lenses in-network. Only provide a value if a copay is required; otherwise set to null." }, "frames_copay": { "type": "integer", "nullable": true, "description": "Single payment that applies to frames in-network. Only provide a value if a copay is required; otherwise set to null." }, "contacts_copay": { "type": "integer", "nullable": true, "description": "Single payment that applies to contacts in-network. Only provide a value if a copay is required; otherwise set to null." }, "exam_allowance": { "type": "integer", "nullable": true, "description": "Amount covered by insurance that applies to exam in-network. Only provide a value if an allowance is part of the cost share; otherwise set to null." }, "lenses_allowance": { "type": "integer", "nullable": true, "description": "Amount covered by insurance that applies to lenses in-network. Only provide a value if an allowance is part of the cost share; otherwise set to null." }, "frames_allowance": { "type": "integer", "nullable": true, "description": "Amount covered by insurance that applies to frames in-network. Only provide a value if an allowance is part of the cost share; otherwise set to null." }, "contacts_allowance": { "type": "integer", "nullable": true, "description": "Amount covered by insurance that applies to contacts in-network. Only provide a value if an allowance is part of the cost share; otherwise set to null." }, "exam_out_allowance": { "type": "integer", "description": "Amount covered by insurance that applies to exam out-of-network." }, "lenses_out_allowance": { "type": "integer", "description": "Amount covered by insurance that applies to lenses out-of-network." }, "frames_out_allowance": { "type": "integer", "description": "Amount covered by insurance that applies to frames out-of-network." }, "contacts_out_allowance": { "type": "integer", "description": "Amount covered by insurance that applies to contacts out-of-network." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "funding", "t1_ee", "t2_ee", "t3_ee", "t4_ee", "t1_gross", "t2_gross", "t3_gross", "t4_gross", "exam_frequency", "lenses_frequency", "frames_frequency", "contacts_frequency" ] }, "examples": { "vision": { "value": { "employer": "7574457f-e9ed-4a65-8baa-72b8088b9f45", "title": "Sample Vision Plan", "carrier": "VSP", "start_date": "2023-01-01", "end_date": "2023-12-31", "from_plan": "837f56e4-cd62-4749-91be-acb043070cc4", "from_action": "RENEWED", "pt": false, "funding": "FUNDING_FULLY", "t1_ee": 85, "t2_ee": 150, "t3_ee": 144, "t4_ee": 235, "t1_gross": 85, "t2_gross": 150, "t3_gross": 144, "t4_gross": 235, "exam_frequency": 12, "lenses_frequency": 12, "frames_frequency": 24, "contacts_frequency": 12, "exam_copay": 10, "lenses_copay": 15, "frames_copay": null, "contacts_copay": null, "exam_allowance": null, "lenses_allowance": null, "frames_allowance": 180, "contacts_allowance": 180, "exam_out_allowance": 45, "lenses_out_allowance": 32, "frames_out_allowance": 44, "contacts_out_allowance": 105 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of plan." }, "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "funding": { "type": "string", "enum": [ "FUNDING_FULLY", "FUNDING_LEVEL", "FUNDING_SELF" ], "description": "Used to differentiate plans within the benefit class based on how employer shares risk with carrier." }, "t1_ee": { "type": "integer", "description": "Amount paid by a single (tier 1) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t2_ee": { "type": "integer", "description": "Amount paid by an employee + spouse (tier 2) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_ee": { "type": "integer", "description": "Amount paid by an employee + children (tier 3) employee per year (PEPY) to cover their portion of the cost of the plan. If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_ee": { "type": "integer", "description": "Amount paid by an employee + family (tier 4) employee per year (PEPY) to cover their portion of the cost of the plan." }, "t1_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover a single (tier 1) employee per year (PEPY)." }, "t2_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + spouse (tier 2) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use the 'Employee + 1' rate." }, "t3_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + children (tier 3) employee per year (PEPY). If 2 tier rate structure, use the 'Family' rate. If it's 3 tiers, use either, the 'Employee + 1' or 'Family' rate. If 5 tiers, use mean of the 3rd and 4th tier." }, "t4_gross": { "type": "integer", "description": "Full amount paid by the employer (before EE contributions) to cover an employee + family (tier 4) employee per year (PEPY)." }, "exam_frequency": { "type": "integer", "description": "How often the exam benefit is covered, in months." }, "lenses_frequency": { "type": "integer", "description": "How often the lenses benefit is covered, in months." }, "frames_frequency": { "type": "integer", "description": "How often the frames benefit is covered, in months." }, "contacts_frequency": { "type": "integer", "description": "How often the contacts benefit is covered, in months." }, "exam_copay": { "type": "integer", "nullable": true, "description": "Single payment that applies to exam in-network. Only provide a value if a copay is required; otherwise set to null." }, "lenses_copay": { "type": "integer", "nullable": true, "description": "Single payment that applies to lenses in-network. Only provide a value if a copay is required; otherwise set to null." }, "frames_copay": { "type": "integer", "nullable": true, "description": "Single payment that applies to frames in-network. Only provide a value if a copay is required; otherwise set to null." }, "contacts_copay": { "type": "integer", "nullable": true, "description": "Single payment that applies to contacts in-network. Only provide a value if a copay is required; otherwise set to null." }, "exam_allowance": { "type": "integer", "nullable": true, "description": "Amount covered by insurance that applies to exam in-network. Only provide a value if an allowance is part of the cost share; otherwise set to null." }, "lenses_allowance": { "type": "integer", "nullable": true, "description": "Amount covered by insurance that applies to lenses in-network. Only provide a value if an allowance is part of the cost share; otherwise set to null." }, "frames_allowance": { "type": "integer", "nullable": true, "description": "Amount covered by insurance that applies to frames in-network. Only provide a value if an allowance is part of the cost share; otherwise set to null." }, "contacts_allowance": { "type": "integer", "nullable": true, "description": "Amount covered by insurance that applies to contacts in-network. Only provide a value if an allowance is part of the cost share; otherwise set to null." }, "exam_out_allowance": { "type": "integer", "description": "Amount covered by insurance that applies to exam out-of-network." }, "lenses_out_allowance": { "type": "integer", "description": "Amount covered by insurance that applies to lenses out-of-network." }, "frames_out_allowance": { "type": "integer", "description": "Amount covered by insurance that applies to frames out-of-network." }, "contacts_out_allowance": { "type": "integer", "description": "Amount covered by insurance that applies to contacts out-of-network." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "funding", "t1_ee", "t2_ee", "t3_ee", "t4_ee", "t1_gross", "t2_gross", "t3_gross", "t4_gross", "exam_frequency", "lenses_frequency", "frames_frequency", "contacts_frequency" ] } } } }, "400": { "description": "Bad request / invalid data", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "array", "description": "List of data validation errors for 'id' field.", "items": { "type": "string" } }, "employer": { "type": "array", "description": "List of data validation errors for 'employer' field.", "items": { "type": "string" } }, "title": { "type": "array", "description": "List of data validation errors for 'title' field.", "items": { "type": "string" } }, "carrier": { "type": "array", "description": "List of data validation errors for 'carrier' field.", "items": { "type": "string" } }, "start_date": { "type": "array", "description": "List of data validation errors for 'start_date' field.", "items": { "type": "string" } }, "end_date": { "type": "array", "description": "List of data validation errors for 'end_date' field.", "items": { "type": "string" } }, "from_plan": { "type": "array", "description": "List of data validation errors for 'from_plan' field.", "items": { "type": "string" } }, "from_action": { "type": "array", "description": "List of data validation errors for 'from_action' field.", "items": { "type": "string" } }, "pt": { "type": "array", "description": "List of data validation errors for 'pt' field.", "items": { "type": "string" } }, "funding": { "type": "array", "description": "List of data validation errors for 'funding' field.", "items": { "type": "string" } }, "t1_ee": { "type": "array", "description": "List of data validation errors for 't1_ee' field.", "items": { "type": "string" } }, "t2_ee": { "type": "array", "description": "List of data validation errors for 't2_ee' field.", "items": { "type": "string" } }, "t3_ee": { "type": "array", "description": "List of data validation errors for 't3_ee' field.", "items": { "type": "string" } }, "t4_ee": { "type": "array", "description": "List of data validation errors for 't4_ee' field.", "items": { "type": "string" } }, "t1_gross": { "type": "array", "description": "List of data validation errors for 't1_gross' field.", "items": { "type": "string" } }, "t2_gross": { "type": "array", "description": "List of data validation errors for 't2_gross' field.", "items": { "type": "string" } }, "t3_gross": { "type": "array", "description": "List of data validation errors for 't3_gross' field.", "items": { "type": "string" } }, "t4_gross": { "type": "array", "description": "List of data validation errors for 't4_gross' field.", "items": { "type": "string" } }, "exam_frequency": { "type": "array", "description": "List of data validation errors for 'exam_frequency' field.", "items": { "type": "string" } }, "lenses_frequency": { "type": "array", "description": "List of data validation errors for 'lenses_frequency' field.", "items": { "type": "string" } }, "frames_frequency": { "type": "array", "description": "List of data validation errors for 'frames_frequency' field.", "items": { "type": "string" } }, "contacts_frequency": { "type": "array", "description": "List of data validation errors for 'contacts_frequency' field.", "items": { "type": "string" } }, "exam_copay": { "type": "array", "description": "List of data validation errors for 'exam_copay' field.", "items": { "type": "string" } }, "lenses_copay": { "type": "array", "description": "List of data validation errors for 'lenses_copay' field.", "items": { "type": "string" } }, "frames_copay": { "type": "array", "description": "List of data validation errors for 'frames_copay' field.", "items": { "type": "string" } }, "contacts_copay": { "type": "array", "description": "List of data validation errors for 'contacts_copay' field.", "items": { "type": "string" } }, "exam_allowance": { "type": "array", "description": "List of data validation errors for 'exam_allowance' field.", "items": { "type": "string" } }, "lenses_allowance": { "type": "array", "description": "List of data validation errors for 'lenses_allowance' field.", "items": { "type": "string" } }, "frames_allowance": { "type": "array", "description": "List of data validation errors for 'frames_allowance' field.", "items": { "type": "string" } }, "contacts_allowance": { "type": "array", "description": "List of data validation errors for 'contacts_allowance' field.", "items": { "type": "string" } }, "exam_out_allowance": { "type": "array", "description": "List of data validation errors for 'exam_out_allowance' field.", "items": { "type": "string" } }, "lenses_out_allowance": { "type": "array", "description": "List of data validation errors for 'lenses_out_allowance' field.", "items": { "type": "string" } }, "frames_out_allowance": { "type": "array", "description": "List of data validation errors for 'frames_out_allowance' field.", "items": { "type": "string" } }, "contacts_out_allowance": { "type": "array", "description": "List of data validation errors for 'contacts_out_allowance' field.", "items": { "type": "string" } } } } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } }, "delete": { "summary": "Delete Vision Plan", "tags": [ "Vision Plans" ], "parameters": [ { "$ref": "#/components/parameters/planID" } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Success." }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/plans/basiclife/": { "post": { "summary": "Create Basic Life Plan", "tags": [ "Basic Life and AD&D Plans" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "type": { "type": "string", "enum": [ "MULTIPLE_OF_SALARY", "FLAT_AMOUNT" ], "description": "Method used to determine the total death benefit. 'MULTIPLE_OF_SALARY' calculates a variable benefit from the employee's salary; 'FLAT_AMOUNT' provides a fixed benefit." }, "multiple": { "type": "number", "format": "integer", "description": "The multiply factor of salary used to calculate a variable total death benefit to be paid to beneficiaries. Required when type is 'MULTIPLE_OF_SALARY'." }, "multiple_max": { "type": "number", "format": "integer", "description": "Used with 'MULTIPLE_OF_SALARY' plans to cap the total death benefit to be paid to beneficiaries." }, "flat_amount": { "type": "number", "format": "integer", "description": "The fixed total death benefit to be paid to beneficiaries. Required when type is 'FLAT_AMOUNT'." }, "add": { "type": "boolean", "description": "Indicates if AD&D insurance is included with (or offered alongside) the life insurance policy." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "type", "add" ] }, "examples": { "basiclife": { "value": { "employer": "7574457f-e9ed-4a65-8baa-72b8088b9f45", "title": "Sample Basic Life and AD&D Plan", "carrier": "Mutual of Omaha", "start_date": "2023-01-01", "end_date": "2023-12-31", "from_plan": "f5635638-1fcd-44d3-9823-d97846774a1a", "from_action": "RENEWED", "pt": false, "type": "MULTIPLE_OF_SALARY", "multiple": 1, "multiple_max": 250000, "flat_amount": null, "add": true } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of plan." }, "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "type": { "type": "string", "enum": [ "MULTIPLE_OF_SALARY", "FLAT_AMOUNT" ], "description": "Method used to determine the total death benefit. 'MULTIPLE_OF_SALARY' calculates a variable benefit from the employee's salary; 'FLAT_AMOUNT' provides a fixed benefit." }, "multiple": { "type": "number", "format": "integer", "description": "The multiply factor of salary used to calculate a variable total death benefit to be paid to beneficiaries. Required when type is 'MULTIPLE_OF_SALARY'." }, "multiple_max": { "type": "number", "format": "integer", "description": "Used with 'MULTIPLE_OF_SALARY' plans to cap the total death benefit to be paid to beneficiaries." }, "flat_amount": { "type": "number", "format": "integer", "description": "The fixed total death benefit to be paid to beneficiaries. Required when type is 'FLAT_AMOUNT'." }, "add": { "type": "boolean", "description": "Indicates if AD&D insurance is included with (or offered alongside) the life insurance policy." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "type", "add" ] } } } }, "400": { "description": "Bad request / invalid data", "content": { "application/json": { "schema": { "type": "object", "properties": { "employer": { "type": "array", "description": "List of data validation errors for 'employer' field.", "items": { "type": "string" } }, "title": { "type": "array", "description": "List of data validation errors for 'title' field.", "items": { "type": "string" } }, "carrier": { "type": "array", "description": "List of data validation errors for 'carrier' field.", "items": { "type": "string" } }, "start_date": { "type": "array", "description": "List of data validation errors for 'start_date' field.", "items": { "type": "string" } }, "end_date": { "type": "array", "description": "List of data validation errors for 'end_date' field.", "items": { "type": "string" } }, "from_plan": { "type": "array", "description": "List of data validation errors for 'from_plan' field.", "items": { "type": "string" } }, "from_action": { "type": "array", "description": "List of data validation errors for 'from_action' field.", "items": { "type": "string" } }, "pt": { "type": "array", "description": "List of data validation errors for 'pt' field.", "items": { "type": "string" } }, "type": { "type": "array", "description": "List of data validation errors for 'type' field.", "items": { "type": "string" } }, "multiple": { "type": "array", "description": "List of data validation errors for 'multiple' field.", "items": { "type": "string" } }, "multiple_max": { "type": "array", "description": "List of data validation errors for 'multiple_max' field.", "items": { "type": "string" } }, "flat_amount": { "type": "array", "description": "List of data validation errors for 'flat_amount' field.", "items": { "type": "string" } }, "add": { "type": "array", "description": "List of data validation errors for 'add' field.", "items": { "type": "string" } } } } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/plans/basiclife/{planID}/": { "get": { "summary": "Get Basic Life Plan", "tags": [ "Basic Life and AD&D Plans" ], "parameters": [ { "$ref": "#/components/parameters/planID" } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of plan." }, "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "type": { "type": "string", "enum": [ "MULTIPLE_OF_SALARY", "FLAT_AMOUNT" ], "description": "Method used to determine the total death benefit. 'MULTIPLE_OF_SALARY' calculates a variable benefit from the employee's salary; 'FLAT_AMOUNT' provides a fixed benefit." }, "multiple": { "type": "number", "format": "integer", "description": "The multiply factor of salary used to calculate a variable total death benefit to be paid to beneficiaries. Required when type is 'MULTIPLE_OF_SALARY'." }, "multiple_max": { "type": "number", "format": "integer", "description": "Used with 'MULTIPLE_OF_SALARY' plans to cap the total death benefit to be paid to beneficiaries." }, "flat_amount": { "type": "number", "format": "integer", "description": "The fixed total death benefit to be paid to beneficiaries. Required when type is 'FLAT_AMOUNT'." }, "add": { "type": "boolean", "description": "Indicates if AD&D insurance is included with (or offered alongside) the life insurance policy." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "type", "add" ] } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } }, "put": { "summary": "Update Basic Life Plan", "tags": [ "Basic Life and AD&D Plans" ], "parameters": [ { "$ref": "#/components/parameters/planID" } ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "type": { "type": "string", "enum": [ "MULTIPLE_OF_SALARY", "FLAT_AMOUNT" ], "description": "Method used to determine the total death benefit. 'MULTIPLE_OF_SALARY' calculates a variable benefit from the employee's salary; 'FLAT_AMOUNT' provides a fixed benefit." }, "multiple": { "type": "number", "format": "integer", "description": "The multiply factor of salary used to calculate a variable total death benefit to be paid to beneficiaries. Required when type is 'MULTIPLE_OF_SALARY'." }, "multiple_max": { "type": "number", "format": "integer", "description": "Used with 'MULTIPLE_OF_SALARY' plans to cap the total death benefit to be paid to beneficiaries." }, "flat_amount": { "type": "number", "format": "integer", "description": "The fixed total death benefit to be paid to beneficiaries. Required when type is 'FLAT_AMOUNT'." }, "add": { "type": "boolean", "description": "Indicates if AD&D insurance is included with (or offered alongside) the life insurance policy." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "type", "add" ] }, "examples": { "basiclife": { "value": { "employer": "7574457f-e9ed-4a65-8baa-72b8088b9f45", "title": "Sample Basic Life and AD&D Plan", "carrier": "Mutual of Omaha", "start_date": "2023-01-01", "end_date": "2023-12-31", "from_plan": "f5635638-1fcd-44d3-9823-d97846774a1a", "from_action": "RENEWED", "pt": false, "type": "MULTIPLE_OF_SALARY", "multiple": 1, "multiple_max": 250000, "flat_amount": null, "add": true } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of plan." }, "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "type": { "type": "string", "enum": [ "MULTIPLE_OF_SALARY", "FLAT_AMOUNT" ], "description": "Method used to determine the total death benefit. 'MULTIPLE_OF_SALARY' calculates a variable benefit from the employee's salary; 'FLAT_AMOUNT' provides a fixed benefit." }, "multiple": { "type": "number", "format": "integer", "description": "The multiply factor of salary used to calculate a variable total death benefit to be paid to beneficiaries. Required when type is 'MULTIPLE_OF_SALARY'." }, "multiple_max": { "type": "number", "format": "integer", "description": "Used with 'MULTIPLE_OF_SALARY' plans to cap the total death benefit to be paid to beneficiaries." }, "flat_amount": { "type": "number", "format": "integer", "description": "The fixed total death benefit to be paid to beneficiaries. Required when type is 'FLAT_AMOUNT'." }, "add": { "type": "boolean", "description": "Indicates if AD&D insurance is included with (or offered alongside) the life insurance policy." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "type", "add" ] } } } }, "400": { "description": "Bad request / invalid data", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "array", "description": "List of data validation errors for 'id' field.", "items": { "type": "string" } }, "employer": { "type": "array", "description": "List of data validation errors for 'employer' field.", "items": { "type": "string" } }, "title": { "type": "array", "description": "List of data validation errors for 'title' field.", "items": { "type": "string" } }, "carrier": { "type": "array", "description": "List of data validation errors for 'carrier' field.", "items": { "type": "string" } }, "start_date": { "type": "array", "description": "List of data validation errors for 'start_date' field.", "items": { "type": "string" } }, "end_date": { "type": "array", "description": "List of data validation errors for 'end_date' field.", "items": { "type": "string" } }, "from_plan": { "type": "array", "description": "List of data validation errors for 'from_plan' field.", "items": { "type": "string" } }, "from_action": { "type": "array", "description": "List of data validation errors for 'from_action' field.", "items": { "type": "string" } }, "pt": { "type": "array", "description": "List of data validation errors for 'pt' field.", "items": { "type": "string" } }, "type": { "type": "array", "description": "List of data validation errors for 'type' field.", "items": { "type": "string" } }, "multiple": { "type": "array", "description": "List of data validation errors for 'multiple' field.", "items": { "type": "string" } }, "multiple_max": { "type": "array", "description": "List of data validation errors for 'multiple_max' field.", "items": { "type": "string" } }, "flat_amount": { "type": "array", "description": "List of data validation errors for 'flat_amount' field.", "items": { "type": "string" } }, "add": { "type": "array", "description": "List of data validation errors for 'add' field.", "items": { "type": "string" } } } } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } }, "delete": { "summary": "Delete Basic Life Plan", "tags": [ "Basic Life and AD&D Plans" ], "parameters": [ { "$ref": "#/components/parameters/planID" } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Success." }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/plans/voluntarylife/": { "post": { "summary": "Create Voluntary Life Plan", "tags": [ "Voluntary Life and AD&D Plans" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "max": { "type": "number", "format": "integer", "description": "Maximum total death benefit amount available to the employee." }, "guarantee_issue": { "type": "number", "format": "integer", "description": "Guarantee issue amount available to the employee without evidence of insurability." }, "max_spouse": { "type": "number", "format": "integer", "description": "Maximum total death benefit amount available to the employee's spouse." }, "max_children": { "type": "number", "format": "integer", "description": "Maximum total death benefit amount available to the employee's children." }, "add": { "type": "boolean", "description": "Indicates if AD&D insurance is included with (or offered alongside) the life insurance policy." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "max", "guarantee_issue", "add" ] }, "examples": { "voluntarylife": { "value": { "employer": "7574457f-e9ed-4a65-8baa-72b8088b9f45", "title": "Sample Voluntary Life and AD&D Plan", "carrier": "Mutual of Omaha", "start_date": "2023-01-01", "end_date": "2023-12-31", "from_plan": "f5635638-1fcd-44d3-9823-d97846774a1a", "from_action": "RENEWED", "pt": false, "max": 500000, "guarantee_issue": 150000, "max_spouse": 250000, "max_children": 10000, "add": true } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of plan." }, "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "max": { "type": "number", "format": "integer", "description": "Maximum total death benefit amount available to the employee." }, "guarantee_issue": { "type": "number", "format": "integer", "description": "Guarantee issue amount available to the employee without evidence of insurability." }, "max_spouse": { "type": "number", "format": "integer", "description": "Maximum total death benefit amount available to the employee's spouse." }, "max_children": { "type": "number", "format": "integer", "description": "Maximum total death benefit amount available to the employee's children." }, "add": { "type": "boolean", "description": "Indicates if AD&D insurance is included with (or offered alongside) the life insurance policy." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "max", "guarantee_issue", "add" ] } } } }, "400": { "description": "Bad request / invalid data", "content": { "application/json": { "schema": { "type": "object", "properties": { "employer": { "type": "array", "description": "List of data validation errors for 'employer' field.", "items": { "type": "string" } }, "title": { "type": "array", "description": "List of data validation errors for 'title' field.", "items": { "type": "string" } }, "carrier": { "type": "array", "description": "List of data validation errors for 'carrier' field.", "items": { "type": "string" } }, "start_date": { "type": "array", "description": "List of data validation errors for 'start_date' field.", "items": { "type": "string" } }, "end_date": { "type": "array", "description": "List of data validation errors for 'end_date' field.", "items": { "type": "string" } }, "from_plan": { "type": "array", "description": "List of data validation errors for 'from_plan' field.", "items": { "type": "string" } }, "from_action": { "type": "array", "description": "List of data validation errors for 'from_action' field.", "items": { "type": "string" } }, "pt": { "type": "array", "description": "List of data validation errors for 'pt' field.", "items": { "type": "string" } }, "max": { "type": "array", "description": "List of data validation errors for 'max' field.", "items": { "type": "string" } }, "guarantee_issue": { "type": "array", "description": "List of data validation errors for 'guarantee_issue' field.", "items": { "type": "string" } }, "max_spouse": { "type": "array", "description": "List of data validation errors for 'max_spouse' field.", "items": { "type": "string" } }, "max_children": { "type": "array", "description": "List of data validation errors for 'max_children' field.", "items": { "type": "string" } }, "add": { "type": "array", "description": "List of data validation errors for 'add' field.", "items": { "type": "string" } } } } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/plans/voluntarylife/{planID}/": { "get": { "summary": "Get Voluntary Life Plan", "tags": [ "Voluntary Life and AD&D Plans" ], "parameters": [ { "$ref": "#/components/parameters/planID" } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of plan." }, "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "max": { "type": "number", "format": "integer", "description": "Maximum total death benefit amount available to the employee." }, "guarantee_issue": { "type": "number", "format": "integer", "description": "Guarantee issue amount available to the employee without evidence of insurability." }, "max_spouse": { "type": "number", "format": "integer", "description": "Maximum total death benefit amount available to the employee's spouse." }, "max_children": { "type": "number", "format": "integer", "description": "Maximum total death benefit amount available to the employee's children." }, "add": { "type": "boolean", "description": "Indicates if AD&D insurance is included with (or offered alongside) the life insurance policy." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "max", "guarantee_issue", "add" ] } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } }, "put": { "summary": "Update Voluntary Life Plan", "tags": [ "Voluntary Life and AD&D Plans" ], "parameters": [ { "$ref": "#/components/parameters/planID" } ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "max": { "type": "number", "format": "integer", "description": "Maximum total death benefit amount available to the employee." }, "guarantee_issue": { "type": "number", "format": "integer", "description": "Guarantee issue amount available to the employee without evidence of insurability." }, "max_spouse": { "type": "number", "format": "integer", "description": "Maximum total death benefit amount available to the employee's spouse." }, "max_children": { "type": "number", "format": "integer", "description": "Maximum total death benefit amount available to the employee's children." }, "add": { "type": "boolean", "description": "Indicates if AD&D insurance is included with (or offered alongside) the life insurance policy." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "max", "guarantee_issue", "add" ] }, "examples": { "voluntarylife": { "value": { "employer": "7574457f-e9ed-4a65-8baa-72b8088b9f45", "title": "Sample Voluntary Life and AD&D Plan", "carrier": "Mutual of Omaha", "start_date": "2023-01-01", "end_date": "2023-12-31", "from_plan": "f5635638-1fcd-44d3-9823-d97846774a1a", "from_action": "RENEWED", "pt": false, "max": 500000, "guarantee_issue": 150000, "max_spouse": 250000, "max_children": 10000, "add": true } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of plan." }, "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "max": { "type": "number", "format": "integer", "description": "Maximum total death benefit amount available to the employee." }, "guarantee_issue": { "type": "number", "format": "integer", "description": "Guarantee issue amount available to the employee without evidence of insurability." }, "max_spouse": { "type": "number", "format": "integer", "description": "Maximum total death benefit amount available to the employee's spouse." }, "max_children": { "type": "number", "format": "integer", "description": "Maximum total death benefit amount available to the employee's children." }, "add": { "type": "boolean", "description": "Indicates if AD&D insurance is included with (or offered alongside) the life insurance policy." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "max", "guarantee_issue", "add" ] } } } }, "400": { "description": "Bad request / invalid data", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "array", "description": "List of data validation errors for 'id' field.", "items": { "type": "string" } }, "employer": { "type": "array", "description": "List of data validation errors for 'employer' field.", "items": { "type": "string" } }, "title": { "type": "array", "description": "List of data validation errors for 'title' field.", "items": { "type": "string" } }, "carrier": { "type": "array", "description": "List of data validation errors for 'carrier' field.", "items": { "type": "string" } }, "start_date": { "type": "array", "description": "List of data validation errors for 'start_date' field.", "items": { "type": "string" } }, "end_date": { "type": "array", "description": "List of data validation errors for 'end_date' field.", "items": { "type": "string" } }, "from_plan": { "type": "array", "description": "List of data validation errors for 'from_plan' field.", "items": { "type": "string" } }, "from_action": { "type": "array", "description": "List of data validation errors for 'from_action' field.", "items": { "type": "string" } }, "pt": { "type": "array", "description": "List of data validation errors for 'pt' field.", "items": { "type": "string" } }, "max": { "type": "array", "description": "List of data validation errors for 'max' field.", "items": { "type": "string" } }, "guarantee_issue": { "type": "array", "description": "List of data validation errors for 'guarantee_issue' field.", "items": { "type": "string" } }, "max_spouse": { "type": "array", "description": "List of data validation errors for 'max_spouse' field.", "items": { "type": "string" } }, "max_children": { "type": "array", "description": "List of data validation errors for 'max_children' field.", "items": { "type": "string" } }, "add": { "type": "array", "description": "List of data validation errors for 'add' field.", "items": { "type": "string" } } } } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } }, "delete": { "summary": "Delete Voluntary Life Plan", "tags": [ "Voluntary Life and AD&D Plans" ], "parameters": [ { "$ref": "#/components/parameters/planID" } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Success." }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/plans/std/": { "post": { "summary": "Create STD Plan", "tags": [ "Short-Term Disability Plans" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "cost_share": { "type": "string", "enum": [ "EMPLOYER_PAID", "EMPLOYEE_COST_SHARE", "VOLUNTARY" ], "description": "Used to differentiate plans within the benefit class based on how premium cost is shared." }, "percentage": { "type": "integer", "description": "Portion of weekly earnings eligible to receive up to a specific maximum amount. Some plans employ a “step-down”, where there are two percentages. Usually a higher percentage to start that drops down after a few weeks. In this case, use a weighted average." }, "weekly_max": { "type": "integer", "description": "Maximum benefit amount employees can receive each week." }, "waiting_days_injury": { "type": "integer", "description": "The number of days the employee must be disabled due to injury before being eligible to receive STD benefits." }, "waiting_days_sick": { "type": "integer", "description": "The number of days the employee must be disabled due to illness before being eligible to receive STD benefits." }, "duration_weeks": { "type": "integer", "description": "The maximum number of weeks that an employee will receive STD benefits. This duration figure does not include the elimination period." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "cost_share", "percentage", "weekly_max", "waiting_days_injury", "waiting_days_sick", "duration_weeks" ] }, "examples": { "std": { "value": { "employer": "e0b6d00a-d304-4b54-a133-05d1a0b1eaa9", "title": "Sample STD Plan", "carrier": "Mutual of Omaha", "start_date": "2023-01-01", "end_date": "2023-12-31", "from_plan": "bfhdye0a-d3d3d404-4bd454-a13tihuf33", "from_action": "RENEWED", "pt": true, "cost_share": "EMPLOYER_PAID", "percentage": 60, "weekly_max": 1250, "waiting_days_injury": 7, "waiting_days_sick": 7, "duration_weeks": 12 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of plan." }, "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "cost_share": { "type": "string", "enum": [ "EMPLOYER_PAID", "EMPLOYEE_COST_SHARE", "VOLUNTARY" ], "description": "Used to differentiate plans within the benefit class based on how premium cost is shared." }, "percentage": { "type": "integer", "description": "Portion of weekly earnings eligible to receive up to a specific maximum amount. Some plans employ a “step-down”, where there are two percentages. Usually a higher percentage to start that drops down after a few weeks. In this case, use a weighted average." }, "weekly_max": { "type": "integer", "description": "Maximum benefit amount employees can receive each week." }, "waiting_days_injury": { "type": "integer", "description": "The number of days the employee must be disabled due to injury before being eligible to receive STD benefits." }, "waiting_days_sick": { "type": "integer", "description": "The number of days the employee must be disabled due to illness before being eligible to receive STD benefits." }, "duration_weeks": { "type": "integer", "description": "The maximum number of weeks that an employee will receive STD benefits. This duration figure does not include the elimination period." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "cost_share", "percentage", "weekly_max", "waiting_days_injury", "waiting_days_sick", "duration_weeks" ] } } } }, "400": { "description": "Bad request / invalid data", "content": { "application/json": { "schema": { "type": "object", "properties": { "employer": { "type": "array", "description": "List of data validation errors for 'employer' field.", "items": { "type": "string" } }, "title": { "type": "array", "description": "List of data validation errors for 'title' field.", "items": { "type": "string" } }, "carrier": { "type": "array", "description": "List of data validation errors for 'carrier' field.", "items": { "type": "string" } }, "start_date": { "type": "array", "description": "List of data validation errors for 'start_date' field.", "items": { "type": "string" } }, "end_date": { "type": "array", "description": "List of data validation errors for 'end_date' field.", "items": { "type": "string" } }, "from_plan": { "type": "array", "description": "List of data validation errors for 'from_plan' field.", "items": { "type": "string" } }, "from_action": { "type": "array", "description": "List of data validation errors for 'from_action' field.", "items": { "type": "string" } }, "pt": { "type": "array", "description": "List of data validation errors for 'pt' field.", "items": { "type": "string" } }, "cost_share": { "type": "array", "description": "List of data validation errors for 'cost_share' field.", "items": { "type": "string" } }, "percentage": { "type": "array", "description": "List of data validation errors for 'percentage' field.", "items": { "type": "string" } }, "weekly_max": { "type": "array", "description": "List of data validation errors for 'weekly_max' field.", "items": { "type": "string" } }, "waiting_days_injury": { "type": "array", "description": "List of data validation errors for 'waiting_days_injury' field.", "items": { "type": "string" } }, "waiting_days_sick": { "type": "array", "description": "List of data validation errors for 'waiting_days_sick' field.", "items": { "type": "string" } }, "duration_weeks": { "type": "array", "description": "List of data validation errors for 'duration_weeks' field.", "items": { "type": "string" } } } } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/plans/std/{planID}/": { "get": { "summary": "Get STD Plan", "tags": [ "Short-Term Disability Plans" ], "parameters": [ { "$ref": "#/components/parameters/planID" } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of plan." }, "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "cost_share": { "type": "string", "enum": [ "EMPLOYER_PAID", "EMPLOYEE_COST_SHARE", "VOLUNTARY" ], "description": "Used to differentiate plans within the benefit class based on how premium cost is shared." }, "percentage": { "type": "integer", "description": "Portion of weekly earnings eligible to receive up to a specific maximum amount. Some plans employ a “step-down”, where there are two percentages. Usually a higher percentage to start that drops down after a few weeks. In this case, use a weighted average." }, "weekly_max": { "type": "integer", "description": "Maximum benefit amount employees can receive each week." }, "waiting_days_injury": { "type": "integer", "description": "The number of days the employee must be disabled due to injury before being eligible to receive STD benefits." }, "waiting_days_sick": { "type": "integer", "description": "The number of days the employee must be disabled due to illness before being eligible to receive STD benefits." }, "duration_weeks": { "type": "integer", "description": "The maximum number of weeks that an employee will receive STD benefits. This duration figure does not include the elimination period." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "cost_share", "percentage", "weekly_max", "waiting_days_injury", "waiting_days_sick", "duration_weeks" ] } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } }, "put": { "summary": "Update STD Plan", "tags": [ "Short-Term Disability Plans" ], "parameters": [ { "$ref": "#/components/parameters/planID" } ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "cost_share": { "type": "string", "enum": [ "EMPLOYER_PAID", "EMPLOYEE_COST_SHARE", "VOLUNTARY" ], "description": "Used to differentiate plans within the benefit class based on how premium cost is shared." }, "percentage": { "type": "integer", "description": "Portion of weekly earnings eligible to receive up to a specific maximum amount. Some plans employ a “step-down”, where there are two percentages. Usually a higher percentage to start that drops down after a few weeks. In this case, use a weighted average." }, "weekly_max": { "type": "integer", "description": "Maximum benefit amount employees can receive each week." }, "waiting_days_injury": { "type": "integer", "description": "The number of days the employee must be disabled due to injury before being eligible to receive STD benefits." }, "waiting_days_sick": { "type": "integer", "description": "The number of days the employee must be disabled due to illness before being eligible to receive STD benefits." }, "duration_weeks": { "type": "integer", "description": "The maximum number of weeks that an employee will receive STD benefits. This duration figure does not include the elimination period." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "cost_share", "percentage", "weekly_max", "waiting_days_injury", "waiting_days_sick", "duration_weeks" ] }, "examples": { "std": { "value": { "employer": "e0b6d00a-d304-4b54-a133-05d1a0b1eaa9", "title": "Sample STD Plan", "carrier": "Mutual of Omaha", "start_date": "2023-01-01", "end_date": "2023-12-31", "from_plan": "bfhdye0a-d3d3d404-4bd454-a13tihuf33", "from_action": "RENEWED", "pt": true, "cost_share": "EMPLOYER_PAID", "percentage": 60, "weekly_max": 1250, "waiting_days_injury": 7, "waiting_days_sick": 7, "duration_weeks": 12 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of plan." }, "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "cost_share": { "type": "string", "enum": [ "EMPLOYER_PAID", "EMPLOYEE_COST_SHARE", "VOLUNTARY" ], "description": "Used to differentiate plans within the benefit class based on how premium cost is shared." }, "percentage": { "type": "integer", "description": "Portion of weekly earnings eligible to receive up to a specific maximum amount. Some plans employ a “step-down”, where there are two percentages. Usually a higher percentage to start that drops down after a few weeks. In this case, use a weighted average." }, "weekly_max": { "type": "integer", "description": "Maximum benefit amount employees can receive each week." }, "waiting_days_injury": { "type": "integer", "description": "The number of days the employee must be disabled due to injury before being eligible to receive STD benefits." }, "waiting_days_sick": { "type": "integer", "description": "The number of days the employee must be disabled due to illness before being eligible to receive STD benefits." }, "duration_weeks": { "type": "integer", "description": "The maximum number of weeks that an employee will receive STD benefits. This duration figure does not include the elimination period." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "cost_share", "percentage", "weekly_max", "waiting_days_injury", "waiting_days_sick", "duration_weeks" ] } } } }, "400": { "description": "Bad request / invalid data", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "array", "description": "List of data validation errors for 'id' field.", "items": { "type": "string" } }, "employer": { "type": "array", "description": "List of data validation errors for 'employer' field.", "items": { "type": "string" } }, "title": { "type": "array", "description": "List of data validation errors for 'title' field.", "items": { "type": "string" } }, "carrier": { "type": "array", "description": "List of data validation errors for 'carrier' field.", "items": { "type": "string" } }, "start_date": { "type": "array", "description": "List of data validation errors for 'start_date' field.", "items": { "type": "string" } }, "end_date": { "type": "array", "description": "List of data validation errors for 'end_date' field.", "items": { "type": "string" } }, "from_plan": { "type": "array", "description": "List of data validation errors for 'from_plan' field.", "items": { "type": "string" } }, "from_action": { "type": "array", "description": "List of data validation errors for 'from_action' field.", "items": { "type": "string" } }, "pt": { "type": "array", "description": "List of data validation errors for 'pt' field.", "items": { "type": "string" } }, "cost_share": { "type": "array", "description": "List of data validation errors for 'cost_share' field.", "items": { "type": "string" } }, "percentage": { "type": "array", "description": "List of data validation errors for 'percentage' field.", "items": { "type": "string" } }, "weekly_max": { "type": "array", "description": "List of data validation errors for 'weekly_max' field.", "items": { "type": "string" } }, "waiting_days_injury": { "type": "array", "description": "List of data validation errors for 'waiting_days_injury' field.", "items": { "type": "string" } }, "waiting_days_sick": { "type": "array", "description": "List of data validation errors for 'waiting_days_sick' field.", "items": { "type": "string" } }, "duration_weeks": { "type": "array", "description": "List of data validation errors for 'duration_weeks' field.", "items": { "type": "string" } } } } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } }, "delete": { "summary": "Delete STD Plan", "tags": [ "Short-Term Disability Plans" ], "parameters": [ { "$ref": "#/components/parameters/planID" } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Success." }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/plans/ltd/": { "post": { "summary": "Create LTD Plan", "tags": [ "Long-Term Disability Plans" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "cost_share": { "type": "string", "enum": [ "EMPLOYER_PAID", "EMPLOYEE_COST_SHARE", "VOLUNTARY" ], "description": "Used to differentiate plans within the benefit class based on how premium cost is shared." }, "percentage": { "type": "integer", "description": "Portion of monthly earnings eligible to receive up to a specific maximum amount. Some plans employ a “step-down”, where there are two percentages. Usually a higher percentage to start that drops down after a few weeks. In this case, use a weighted average." }, "monthly_max": { "type": "integer", "description": "Maximum benefit amount employees can receive each month." }, "waiting_weeks": { "type": "integer", "description": "The number of weeks the employee must be disabled before being eligible to receive LTD benefits." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "cost_share", "percentage", "monthly_max", "waiting_weeks" ] }, "examples": { "ltd": { "value": { "employer": "e0b6d00a-d304-4b54-a133-05d1a0b1eaa9", "title": "Sample LTD Plan", "carrier": "Mutual of Omaha", "start_date": "2023-01-01", "end_date": "2023-12-31", "from_plan": "bfhdye0a-d3d3d404-4bd454-a13tihuf33", "from_action": "RENEWED", "pt": true, "cost_share": "EMPLOYER_PAID", "percentage": 60, "monthly_max": 12750, "waiting_weeks": 26 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of plan." }, "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "cost_share": { "type": "string", "enum": [ "EMPLOYER_PAID", "EMPLOYEE_COST_SHARE", "VOLUNTARY" ], "description": "Used to differentiate plans within the benefit class based on how premium cost is shared." }, "percentage": { "type": "integer", "description": "Portion of monthly earnings eligible to receive up to a specific maximum amount. Some plans employ a “step-down”, where there are two percentages. Usually a higher percentage to start that drops down after a few weeks. In this case, use a weighted average." }, "monthly_max": { "type": "integer", "description": "Maximum benefit amount employees can receive each month." }, "waiting_weeks": { "type": "integer", "description": "The number of weeks the employee must be disabled before being eligible to receive LTD benefits." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "cost_share", "percentage", "monthly_max", "waiting_weeks" ] } } } }, "400": { "description": "Bad request / invalid data", "content": { "application/json": { "schema": { "type": "object", "properties": { "employer": { "type": "array", "description": "List of data validation errors for 'employer' field.", "items": { "type": "string" } }, "title": { "type": "array", "description": "List of data validation errors for 'title' field.", "items": { "type": "string" } }, "carrier": { "type": "array", "description": "List of data validation errors for 'carrier' field.", "items": { "type": "string" } }, "start_date": { "type": "array", "description": "List of data validation errors for 'start_date' field.", "items": { "type": "string" } }, "end_date": { "type": "array", "description": "List of data validation errors for 'end_date' field.", "items": { "type": "string" } }, "from_plan": { "type": "array", "description": "List of data validation errors for 'from_plan' field.", "items": { "type": "string" } }, "from_action": { "type": "array", "description": "List of data validation errors for 'from_action' field.", "items": { "type": "string" } }, "pt": { "type": "array", "description": "List of data validation errors for 'pt' field.", "items": { "type": "string" } }, "cost_share": { "type": "array", "description": "List of data validation errors for 'cost_share' field.", "items": { "type": "string" } }, "percentage": { "type": "array", "description": "List of data validation errors for 'percentage' field.", "items": { "type": "string" } }, "monthly_max": { "type": "array", "description": "List of data validation errors for 'monthly_max' field.", "items": { "type": "string" } }, "waiting_weeks": { "type": "array", "description": "List of data validation errors for 'waiting_weeks' field.", "items": { "type": "string" } } } } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/plans/ltd/{planID}/": { "get": { "summary": "Get LTD Plan", "tags": [ "Long-Term Disability Plans" ], "parameters": [ { "$ref": "#/components/parameters/planID" } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of plan." }, "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "cost_share": { "type": "string", "enum": [ "EMPLOYER_PAID", "EMPLOYEE_COST_SHARE", "VOLUNTARY" ], "description": "Used to differentiate plans within the benefit class based on how premium cost is shared." }, "percentage": { "type": "integer", "description": "Portion of monthly earnings eligible to receive up to a specific maximum amount. Some plans employ a “step-down”, where there are two percentages. Usually a higher percentage to start that drops down after a few weeks. In this case, use a weighted average." }, "monthly_max": { "type": "integer", "description": "Maximum benefit amount employees can receive each month." }, "waiting_weeks": { "type": "integer", "description": "The number of weeks the employee must be disabled before being eligible to receive LTD benefits." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "cost_share", "percentage", "monthly_max", "waiting_weeks" ] } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } }, "put": { "summary": "Update LTD Plan", "tags": [ "Long-Term Disability Plans" ], "parameters": [ { "$ref": "#/components/parameters/planID" } ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "cost_share": { "type": "string", "enum": [ "EMPLOYER_PAID", "EMPLOYEE_COST_SHARE", "VOLUNTARY" ], "description": "Used to differentiate plans within the benefit class based on how premium cost is shared." }, "percentage": { "type": "integer", "description": "Portion of monthly earnings eligible to receive up to a specific maximum amount. Some plans employ a “step-down”, where there are two percentages. Usually a higher percentage to start that drops down after a few weeks. In this case, use a weighted average." }, "monthly_max": { "type": "integer", "description": "Maximum benefit amount employees can receive each month." }, "waiting_weeks": { "type": "integer", "description": "The number of weeks the employee must be disabled before being eligible to receive LTD benefits." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "cost_share", "percentage", "monthly_max", "waiting_weeks" ] }, "examples": { "ltd": { "value": { "employer": "e0b6d00a-d304-4b54-a133-05d1a0b1eaa9", "title": "Sample LTD Plan", "carrier": "Mutual of Omaha", "start_date": "2023-01-01", "end_date": "2023-12-31", "from_plan": "bfhdye0a-d3d3d404-4bd454-a13tihuf33", "from_action": "RENEWED", "pt": true, "cost_share": "EMPLOYER_PAID", "percentage": 60, "monthly_max": 12750, "waiting_weeks": 26 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of plan." }, "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "pt": { "type": "boolean", "description": "Is benefit offered to part time employees?" }, "cost_share": { "type": "string", "enum": [ "EMPLOYER_PAID", "EMPLOYEE_COST_SHARE", "VOLUNTARY" ], "description": "Used to differentiate plans within the benefit class based on how premium cost is shared." }, "percentage": { "type": "integer", "description": "Portion of monthly earnings eligible to receive up to a specific maximum amount. Some plans employ a “step-down”, where there are two percentages. Usually a higher percentage to start that drops down after a few weeks. In this case, use a weighted average." }, "monthly_max": { "type": "integer", "description": "Maximum benefit amount employees can receive each month." }, "waiting_weeks": { "type": "integer", "description": "The number of weeks the employee must be disabled before being eligible to receive LTD benefits." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "pt", "cost_share", "percentage", "monthly_max", "waiting_weeks" ] } } } }, "400": { "description": "Bad request / invalid data", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "array", "description": "List of data validation errors for 'id' field.", "items": { "type": "string" } }, "employer": { "type": "array", "description": "List of data validation errors for 'employer' field.", "items": { "type": "string" } }, "title": { "type": "array", "description": "List of data validation errors for 'title' field.", "items": { "type": "string" } }, "carrier": { "type": "array", "description": "List of data validation errors for 'carrier' field.", "items": { "type": "string" } }, "start_date": { "type": "array", "description": "List of data validation errors for 'start_date' field.", "items": { "type": "string" } }, "end_date": { "type": "array", "description": "List of data validation errors for 'end_date' field.", "items": { "type": "string" } }, "from_plan": { "type": "array", "description": "List of data validation errors for 'from_plan' field.", "items": { "type": "string" } }, "from_action": { "type": "array", "description": "List of data validation errors for 'from_action' field.", "items": { "type": "string" } }, "pt": { "type": "array", "description": "List of data validation errors for 'pt' field.", "items": { "type": "string" } }, "cost_share": { "type": "array", "description": "List of data validation errors for 'cost_share' field.", "items": { "type": "string" } }, "percentage": { "type": "array", "description": "List of data validation errors for 'percentage' field.", "items": { "type": "string" } }, "monthly_max": { "type": "array", "description": "List of data validation errors for 'monthly_max' field.", "items": { "type": "string" } }, "waiting_weeks": { "type": "array", "description": "List of data validation errors for 'waiting_weeks' field.", "items": { "type": "string" } } } } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } }, "delete": { "summary": "Delete LTD Plan", "tags": [ "Long-Term Disability Plans" ], "parameters": [ { "$ref": "#/components/parameters/planID" } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Success." }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/plans/stoploss/": { "post": { "summary": "Create Stop Loss Plan", "tags": [ "Stop Loss Plans" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "spec_ded": { "type": "integer", "description": "The dollar amount to be paid by the plan on each covered individual before the stop loss policy kicks in to reimburse expenses incurred during the contract period." }, "spec_rate_single": { "type": "integer", "description": "Annual amount paid by employer for specific stop loss insurance for single tier employees." }, "spec_rate_family": { "type": "integer", "description": "Annual amount paid by employer for specific stop loss insurance for family tier employees." }, "num_lasers": { "type": "integer", "description": "Number of individuals covered by the stop loss policy at a higher Specific deductible than the rest of the group, based on prior claims experience or known conditions." }, "agg_rate": { "type": "integer", "description": "Annual amount paid by employer for aggregate stop-loss insurance per employee. If Aggregate insurance is not offered, set to null." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "spec_ded", "spec_rate_single", "spec_rate_family", "num_lasers" ] }, "examples": { "stoploss": { "value": { "employer": "7574457f-e9ed-4a65-8baa-72b8088b9f45", "title": "Sample Stop Loss", "carrier": "Sun Life", "start_date": "2023-01-01", "end_date": "2023-12-31", "from_plan": null, "from_action": null, "spec_ded": 100000, "spec_rate_single": 1700, "spec_rate_family": 4200, "num_lasers": 2, "agg_rate": 89 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of plan." }, "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "spec_ded": { "type": "integer", "description": "The dollar amount to be paid by the plan on each covered individual before the stop loss policy kicks in to reimburse expenses incurred during the contract period." }, "spec_rate_single": { "type": "integer", "description": "Annual amount paid by employer for specific stop loss insurance for single tier employees." }, "spec_rate_family": { "type": "integer", "description": "Annual amount paid by employer for specific stop loss insurance for family tier employees." }, "num_lasers": { "type": "integer", "description": "Number of individuals covered by the stop loss policy at a higher Specific deductible than the rest of the group, based on prior claims experience or known conditions." }, "agg_rate": { "type": "integer", "description": "Annual amount paid by employer for aggregate stop-loss insurance per employee. If Aggregate insurance is not offered, set to null." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "spec_ded", "spec_rate_single", "spec_rate_family", "num_lasers" ] } } } }, "400": { "description": "Bad request / invalid data", "content": { "application/json": { "schema": { "type": "object", "properties": { "employer": { "type": "array", "description": "List of data validation errors for 'employer' field.", "items": { "type": "string" } }, "title": { "type": "array", "description": "List of data validation errors for 'title' field.", "items": { "type": "string" } }, "carrier": { "type": "array", "description": "List of data validation errors for 'carrier' field.", "items": { "type": "string" } }, "start_date": { "type": "array", "description": "List of data validation errors for 'start_date' field.", "items": { "type": "string" } }, "end_date": { "type": "array", "description": "List of data validation errors for 'end_date' field.", "items": { "type": "string" } }, "from_plan": { "type": "array", "description": "List of data validation errors for 'from_plan' field.", "items": { "type": "string" } }, "from_action": { "type": "array", "description": "List of data validation errors for 'from_action' field.", "items": { "type": "string" } }, "spec_ded": { "type": "array", "description": "List of data validation errors for 'spec_ded' field.", "items": { "type": "string" } }, "spec_rate_single": { "type": "array", "description": "List of data validation errors for 'spec_rate_single' field.", "items": { "type": "string" } }, "spec_rate_family": { "type": "array", "description": "List of data validation errors for 'spec_rate_family' field.", "items": { "type": "string" } }, "num_lasers": { "type": "array", "description": "List of data validation errors for 'num_lasers' field.", "items": { "type": "string" } }, "agg_rate": { "type": "array", "description": "List of data validation errors for 'agg_rate' field.", "items": { "type": "string" } } } } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/plans/stoploss/{planID}/": { "get": { "summary": "Get Stop Loss Plan", "tags": [ "Stop Loss Plans" ], "parameters": [ { "$ref": "#/components/parameters/planID" } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of plan." }, "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "spec_ded": { "type": "integer", "description": "The dollar amount to be paid by the plan on each covered individual before the stop loss policy kicks in to reimburse expenses incurred during the contract period." }, "spec_rate_single": { "type": "integer", "description": "Annual amount paid by employer for specific stop loss insurance for single tier employees." }, "spec_rate_family": { "type": "integer", "description": "Annual amount paid by employer for specific stop loss insurance for family tier employees." }, "num_lasers": { "type": "integer", "description": "Number of individuals covered by the stop loss policy at a higher Specific deductible than the rest of the group, based on prior claims experience or known conditions." }, "agg_rate": { "type": "integer", "description": "Annual amount paid by employer for aggregate stop-loss insurance per employee. If Aggregate insurance is not offered, set to null." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "spec_ded", "spec_rate_single", "spec_rate_family", "num_lasers" ] } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } }, "put": { "summary": "Update Stop Loss Plan", "tags": [ "Stop Loss Plans" ], "parameters": [ { "$ref": "#/components/parameters/planID" } ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "spec_ded": { "type": "integer", "description": "The dollar amount to be paid by the plan on each covered individual before the stop loss policy kicks in to reimburse expenses incurred during the contract period." }, "spec_rate_single": { "type": "integer", "description": "Annual amount paid by employer for specific stop loss insurance for single tier employees." }, "spec_rate_family": { "type": "integer", "description": "Annual amount paid by employer for specific stop loss insurance for family tier employees." }, "num_lasers": { "type": "integer", "description": "Number of individuals covered by the stop loss policy at a higher Specific deductible than the rest of the group, based on prior claims experience or known conditions." }, "agg_rate": { "type": "integer", "description": "Annual amount paid by employer for aggregate stop-loss insurance per employee. If Aggregate insurance is not offered, set to null." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "spec_ded", "spec_rate_single", "spec_rate_family", "num_lasers" ] }, "examples": { "stoploss": { "value": { "employer": "7574457f-e9ed-4a65-8baa-72b8088b9f45", "title": "Sample Stop Loss", "carrier": "Sun Life", "start_date": "2023-01-01", "end_date": "2023-12-31", "from_plan": null, "from_action": null, "spec_ded": 100000, "spec_rate_single": 1700, "spec_rate_family": 4200, "num_lasers": 2, "agg_rate": 89 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of plan." }, "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "spec_ded": { "type": "integer", "description": "The dollar amount to be paid by the plan on each covered individual before the stop loss policy kicks in to reimburse expenses incurred during the contract period." }, "spec_rate_single": { "type": "integer", "description": "Annual amount paid by employer for specific stop loss insurance for single tier employees." }, "spec_rate_family": { "type": "integer", "description": "Annual amount paid by employer for specific stop loss insurance for family tier employees." }, "num_lasers": { "type": "integer", "description": "Number of individuals covered by the stop loss policy at a higher Specific deductible than the rest of the group, based on prior claims experience or known conditions." }, "agg_rate": { "type": "integer", "description": "Annual amount paid by employer for aggregate stop-loss insurance per employee. If Aggregate insurance is not offered, set to null." } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "spec_ded", "spec_rate_single", "spec_rate_family", "num_lasers" ] } } } }, "400": { "description": "Bad request / invalid data", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "array", "description": "List of data validation errors for 'id' field.", "items": { "type": "string" } }, "employer": { "type": "array", "description": "List of data validation errors for 'employer' field.", "items": { "type": "string" } }, "title": { "type": "array", "description": "List of data validation errors for 'title' field.", "items": { "type": "string" } }, "carrier": { "type": "array", "description": "List of data validation errors for 'carrier' field.", "items": { "type": "string" } }, "start_date": { "type": "array", "description": "List of data validation errors for 'start_date' field.", "items": { "type": "string" } }, "end_date": { "type": "array", "description": "List of data validation errors for 'end_date' field.", "items": { "type": "string" } }, "from_plan": { "type": "array", "description": "List of data validation errors for 'from_plan' field.", "items": { "type": "string" } }, "from_action": { "type": "array", "description": "List of data validation errors for 'from_action' field.", "items": { "type": "string" } }, "spec_ded": { "type": "array", "description": "List of data validation errors for 'spec_ded' field.", "items": { "type": "string" } }, "spec_rate_single": { "type": "array", "description": "List of data validation errors for 'spec_rate_single' field.", "items": { "type": "string" } }, "spec_rate_family": { "type": "array", "description": "List of data validation errors for 'spec_rate_family' field.", "items": { "type": "string" } }, "num_lasers": { "type": "array", "description": "List of data validation errors for 'num_lasers' field.", "items": { "type": "string" } }, "agg_rate": { "type": "array", "description": "List of data validation errors for 'agg_rate' field.", "items": { "type": "string" } } } } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } }, "delete": { "summary": "Delete Stop Loss Plan", "tags": [ "Stop Loss Plans" ], "parameters": [ { "$ref": "#/components/parameters/planID" } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Success." }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/plans/supplemental/": { "post": { "summary": "Create Supplemental Plan", "tags": [ "Supplemental Plans" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "critical_illness": { "type": "boolean", "description": "Is Critical Illness insurance offered as part of the supplemental plan?" }, "hospital_indemnity": { "type": "boolean", "description": "Is Hospital Indemnity insurance offered as part of the supplemental plan?" }, "accident": { "type": "boolean", "description": "Is Accident insurance offered as part of the supplemental plan?" }, "cancer": { "type": "boolean", "description": "Is Cancer insurance offered as part of the supplemental plan?" }, "pet": { "type": "boolean", "description": "Is Pet insurance offered as part of the supplemental plan?" }, "legal_assist": { "type": "boolean", "description": "Is Legal Assistance offered as part of the supplemental plan?" }, "credit_protection": { "type": "boolean", "description": "Is Credit Protection offered as part of the supplemental plan?" }, "tuition_reimburse": { "type": "boolean", "description": "Is Tuition Reimbursement offered as part of the supplemental plan?" } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "critical_illness", "hospital_indemnity", "accident", "cancer", "pet", "legal_assist", "credit_protection", "tuition_reimburse" ] }, "examples": { "supplemental": { "value": { "employer": "7574457f-e9ed-4a65-8baa-72b8088b9f45", "title": "Sample Supplemental Plan", "carrier": "Aflac", "start_date": "2023-01-01", "end_date": "2023-12-31", "from_plan": null, "from_action": null, "critical_illness": true, "hospital_indemnity": true, "accident": true, "cancer": false, "pet": false, "legal_assist": true, "credit_protection": false, "tuition_reimburse": false } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of plan." }, "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "critical_illness": { "type": "boolean", "description": "Is Critical Illness insurance offered as part of the supplemental plan?" }, "hospital_indemnity": { "type": "boolean", "description": "Is Hospital Indemnity insurance offered as part of the supplemental plan?" }, "accident": { "type": "boolean", "description": "Is Accident insurance offered as part of the supplemental plan?" }, "cancer": { "type": "boolean", "description": "Is Cancer insurance offered as part of the supplemental plan?" }, "pet": { "type": "boolean", "description": "Is Pet insurance offered as part of the supplemental plan?" }, "legal_assist": { "type": "boolean", "description": "Is Legal Assistance offered as part of the supplemental plan?" }, "credit_protection": { "type": "boolean", "description": "Is Credit Protection offered as part of the supplemental plan?" }, "tuition_reimburse": { "type": "boolean", "description": "Is Tuition Reimbursement offered as part of the supplemental plan?" } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "critical_illness", "hospital_indemnity", "accident", "cancer", "pet", "legal_assist", "credit_protection", "tuition_reimburse" ] } } } }, "400": { "description": "Bad request / invalid data", "content": { "application/json": { "schema": { "type": "object", "properties": { "employer": { "type": "array", "description": "List of data validation errors for 'employer' field.", "items": { "type": "string" } }, "title": { "type": "array", "description": "List of data validation errors for 'title' field.", "items": { "type": "string" } }, "carrier": { "type": "array", "description": "List of data validation errors for 'carrier' field.", "items": { "type": "string" } }, "start_date": { "type": "array", "description": "List of data validation errors for 'start_date' field.", "items": { "type": "string" } }, "end_date": { "type": "array", "description": "List of data validation errors for 'end_date' field.", "items": { "type": "string" } }, "from_plan": { "type": "array", "description": "List of data validation errors for 'from_plan' field.", "items": { "type": "string" } }, "from_action": { "type": "array", "description": "List of data validation errors for 'from_action' field.", "items": { "type": "string" } }, "critical_illness": { "type": "array", "description": "List of data validation errors for 'critical_illness' field.", "items": { "type": "string" } }, "hospital_indemnity": { "type": "array", "description": "List of data validation errors for 'hospital_indemnity' field.", "items": { "type": "string" } }, "accident": { "type": "array", "description": "List of data validation errors for 'accident' field.", "items": { "type": "string" } }, "cancer": { "type": "array", "description": "List of data validation errors for 'cancer' field.", "items": { "type": "string" } }, "pet": { "type": "array", "description": "List of data validation errors for 'pet' field.", "items": { "type": "string" } }, "legal_assist": { "type": "array", "description": "List of data validation errors for 'legal_assist' field.", "items": { "type": "string" } }, "credit_protection": { "type": "array", "description": "List of data validation errors for 'credit_protection' field.", "items": { "type": "string" } }, "tuition_reimburse": { "type": "array", "description": "List of data validation errors for 'tuition_reimburse' field.", "items": { "type": "string" } } } } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/plans/supplemental/{planID}/": { "get": { "summary": "Get Supplemental Plan", "tags": [ "Supplemental Plans" ], "parameters": [ { "$ref": "#/components/parameters/planID" } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of plan." }, "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "critical_illness": { "type": "boolean", "description": "Is Critical Illness insurance offered as part of the supplemental plan?" }, "hospital_indemnity": { "type": "boolean", "description": "Is Hospital Indemnity insurance offered as part of the supplemental plan?" }, "accident": { "type": "boolean", "description": "Is Accident insurance offered as part of the supplemental plan?" }, "cancer": { "type": "boolean", "description": "Is Cancer insurance offered as part of the supplemental plan?" }, "pet": { "type": "boolean", "description": "Is Pet insurance offered as part of the supplemental plan?" }, "legal_assist": { "type": "boolean", "description": "Is Legal Assistance offered as part of the supplemental plan?" }, "credit_protection": { "type": "boolean", "description": "Is Credit Protection offered as part of the supplemental plan?" }, "tuition_reimburse": { "type": "boolean", "description": "Is Tuition Reimbursement offered as part of the supplemental plan?" } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "critical_illness", "hospital_indemnity", "accident", "cancer", "pet", "legal_assist", "credit_protection", "tuition_reimburse" ] } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } }, "put": { "summary": "Update Supplemental Plan", "tags": [ "Supplemental Plans" ], "parameters": [ { "$ref": "#/components/parameters/planID" } ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "critical_illness": { "type": "boolean", "description": "Is Critical Illness insurance offered as part of the supplemental plan?" }, "hospital_indemnity": { "type": "boolean", "description": "Is Hospital Indemnity insurance offered as part of the supplemental plan?" }, "accident": { "type": "boolean", "description": "Is Accident insurance offered as part of the supplemental plan?" }, "cancer": { "type": "boolean", "description": "Is Cancer insurance offered as part of the supplemental plan?" }, "pet": { "type": "boolean", "description": "Is Pet insurance offered as part of the supplemental plan?" }, "legal_assist": { "type": "boolean", "description": "Is Legal Assistance offered as part of the supplemental plan?" }, "credit_protection": { "type": "boolean", "description": "Is Credit Protection offered as part of the supplemental plan?" }, "tuition_reimburse": { "type": "boolean", "description": "Is Tuition Reimbursement offered as part of the supplemental plan?" } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "critical_illness", "hospital_indemnity", "accident", "cancer", "pet", "legal_assist", "credit_protection", "tuition_reimburse" ] }, "examples": { "supplemental": { "value": { "employer": "7574457f-e9ed-4a65-8baa-72b8088b9f45", "title": "Sample Supplemental Plan", "carrier": "Aflac", "start_date": "2023-01-01", "end_date": "2023-12-31", "from_plan": null, "from_action": null, "critical_illness": true, "hospital_indemnity": true, "accident": true, "cancer": false, "pet": false, "legal_assist": true, "credit_protection": false, "tuition_reimburse": false } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of plan." }, "employer": { "type": "string", "format": "uuid", "description": "ID of employer that offers plan." }, "title": { "type": "string", "description": "Unique plan title to identify and differentiate. Can match title provided by insurer." }, "carrier": { "type": "string", "description": "Name of insurance company for fully-insured plans and ASO provider for self-insured plans." }, "start_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "end_date": { "type": "string", "format": "date", "description": "Formated YYYY-MM-DD." }, "from_plan": { "type": "string", "format": "uuid", "description": "ID of prior year plan from which current plan is renewed or converted." }, "from_action": { "type": "string", "nullable": true, "enum": [ "RENEWED", "CONVERTED", null ], "description": "Prior year plan is renewed if with the same carrier or converted if moved to a different carrier." }, "critical_illness": { "type": "boolean", "description": "Is Critical Illness insurance offered as part of the supplemental plan?" }, "hospital_indemnity": { "type": "boolean", "description": "Is Hospital Indemnity insurance offered as part of the supplemental plan?" }, "accident": { "type": "boolean", "description": "Is Accident insurance offered as part of the supplemental plan?" }, "cancer": { "type": "boolean", "description": "Is Cancer insurance offered as part of the supplemental plan?" }, "pet": { "type": "boolean", "description": "Is Pet insurance offered as part of the supplemental plan?" }, "legal_assist": { "type": "boolean", "description": "Is Legal Assistance offered as part of the supplemental plan?" }, "credit_protection": { "type": "boolean", "description": "Is Credit Protection offered as part of the supplemental plan?" }, "tuition_reimburse": { "type": "boolean", "description": "Is Tuition Reimbursement offered as part of the supplemental plan?" } }, "required": [ "employer", "title", "carrier", "start_date", "end_date", "critical_illness", "hospital_indemnity", "accident", "cancer", "pet", "legal_assist", "credit_protection", "tuition_reimburse" ] } } } }, "400": { "description": "Bad request / invalid data", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "array", "description": "List of data validation errors for 'id' field.", "items": { "type": "string" } }, "employer": { "type": "array", "description": "List of data validation errors for 'employer' field.", "items": { "type": "string" } }, "title": { "type": "array", "description": "List of data validation errors for 'title' field.", "items": { "type": "string" } }, "carrier": { "type": "array", "description": "List of data validation errors for 'carrier' field.", "items": { "type": "string" } }, "start_date": { "type": "array", "description": "List of data validation errors for 'start_date' field.", "items": { "type": "string" } }, "end_date": { "type": "array", "description": "List of data validation errors for 'end_date' field.", "items": { "type": "string" } }, "from_plan": { "type": "array", "description": "List of data validation errors for 'from_plan' field.", "items": { "type": "string" } }, "from_action": { "type": "array", "description": "List of data validation errors for 'from_action' field.", "items": { "type": "string" } }, "critical_illness": { "type": "array", "description": "List of data validation errors for 'critical_illness' field.", "items": { "type": "string" } }, "hospital_indemnity": { "type": "array", "description": "List of data validation errors for 'hospital_indemnity' field.", "items": { "type": "string" } }, "accident": { "type": "array", "description": "List of data validation errors for 'accident' field.", "items": { "type": "string" } }, "cancer": { "type": "array", "description": "List of data validation errors for 'cancer' field.", "items": { "type": "string" } }, "pet": { "type": "array", "description": "List of data validation errors for 'pet' field.", "items": { "type": "string" } }, "legal_assist": { "type": "array", "description": "List of data validation errors for 'legal_assist' field.", "items": { "type": "string" } }, "credit_protection": { "type": "array", "description": "List of data validation errors for 'credit_protection' field.", "items": { "type": "string" } }, "tuition_reimburse": { "type": "array", "description": "List of data validation errors for 'tuition_reimburse' field.", "items": { "type": "string" } } } } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } }, "delete": { "summary": "Delete Supplemental Plan", "tags": [ "Supplemental Plans" ], "parameters": [ { "$ref": "#/components/parameters/planID" } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Success." }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/users/": { "post": { "summary": "Create User", "tags": [ "Manage Users" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "User's work email address." }, "first_name": { "type": "string", "description": "User's first name." }, "last_name": { "type": "string", "description": "User's last name." }, "division_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true, "description": "Unique ID assigned to a dedicated group within your account ensuring the security and protection of benefit data. Only users assigned to a division can view, edit, and report on employers/plans within that division." } }, "required": [ "email", "first_name", "last_name", "division_ids" ] }, "examples": { "user": { "value": { "email": "demo_user@bnchmrk.com", "first_name": "Demo", "last_name": "User", "division_ids": [ "f5635638-1fcd-44d3-9823-d97846774a1a" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of user." }, "username": { "type": "string", "description": "Unique username assigned to user." }, "email": { "type": "string", "description": "User's work email address." }, "first_name": { "type": "string", "description": "User's first name." }, "last_name": { "type": "string", "description": "User's last name." }, "division_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true, "description": "Unique ID assigned to a dedicated group within your account ensuring the security and protection of benefit data. Only users assigned to a division can view, edit, and report on employers/plans within that division." } }, "required": [ "email", "first_name", "last_name", "division_ids" ] } } } }, "400": { "description": "Bad request / invalid data", "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "array", "description": "List of data validation errors for 'email' field.", "items": { "type": "string" } }, "first_name": { "type": "array", "description": "List of data validation errors for 'first_name' field.", "items": { "type": "string" } }, "last_name": { "type": "array", "description": "List of data validation errors for 'last_name' field.", "items": { "type": "string" } }, "division_ids": { "type": "array", "description": "List of data validation errors for 'division_ids' field.", "items": { "type": "string" } } } } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/users/{userID}/": { "get": { "summary": "Get User by ID", "tags": [ "Manage Users" ], "parameters": [ { "$ref": "#/components/parameters/userID" } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of user." }, "username": { "type": "string", "description": "Unique username assigned to user." }, "email": { "type": "string", "description": "User's work email address." }, "first_name": { "type": "string", "description": "User's first name." }, "last_name": { "type": "string", "description": "User's last name." }, "division_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true, "description": "Unique ID assigned to a dedicated group within your account ensuring the security and protection of benefit data. Only users assigned to a division can view, edit, and report on employers/plans within that division." } }, "required": [ "email", "first_name", "last_name", "division_ids" ] } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } }, "put": { "summary": "Update User", "tags": [ "Manage Users" ], "parameters": [ { "$ref": "#/components/parameters/userID" } ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "User's work email address." }, "first_name": { "type": "string", "description": "User's first name." }, "last_name": { "type": "string", "description": "User's last name." }, "division_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true, "description": "Unique ID assigned to a dedicated group within your account ensuring the security and protection of benefit data. Only users assigned to a division can view, edit, and report on employers/plans within that division." } }, "required": [ "email", "first_name", "last_name", "division_ids" ] }, "examples": { "user": { "value": { "email": "demo_user@bnchmrk.com", "first_name": "Demo", "last_name": "User", "division_ids": [ "f5635638-1fcd-44d3-9823-d97846774a1a" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of user." }, "username": { "type": "string", "description": "Unique username assigned to user." }, "email": { "type": "string", "description": "User's work email address." }, "first_name": { "type": "string", "description": "User's first name." }, "last_name": { "type": "string", "description": "User's last name." }, "division_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true, "description": "Unique ID assigned to a dedicated group within your account ensuring the security and protection of benefit data. Only users assigned to a division can view, edit, and report on employers/plans within that division." } }, "required": [ "email", "first_name", "last_name", "division_ids" ] } } } }, "400": { "description": "Bad request / invalid data", "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "array", "description": "List of data validation errors for 'email' field.", "items": { "type": "string" } }, "first_name": { "type": "array", "description": "List of data validation errors for 'first_name' field.", "items": { "type": "string" } }, "last_name": { "type": "array", "description": "List of data validation errors for 'last_name' field.", "items": { "type": "string" } }, "division_ids": { "type": "array", "description": "List of data validation errors for 'division_ids' field.", "items": { "type": "string" } } } } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } }, "delete": { "summary": "Delete User", "tags": [ "Manage Users" ], "parameters": [ { "$ref": "#/components/parameters/userID" } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Success." }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/users/byEmail/{email}/": { "get": { "summary": "Get User by Email", "tags": [ "Manage Users" ], "parameters": [ { "$ref": "#/components/parameters/email" } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of user." }, "username": { "type": "string", "description": "Unique username assigned to user." }, "email": { "type": "string", "description": "User's work email address." }, "first_name": { "type": "string", "description": "User's first name." }, "last_name": { "type": "string", "description": "User's last name." }, "division_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true, "description": "Unique ID assigned to a dedicated group within your account ensuring the security and protection of benefit data. Only users assigned to a division can view, edit, and report on employers/plans within that division." } }, "required": [ "email", "first_name", "last_name", "division_ids" ] } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/users/list/": { "get": { "summary": "Get Users List", "tags": [ "Manage Users" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of user." }, "email": { "type": "string", "description": "User's work email address." }, "username": { "type": "string", "description": "Unique username assigned to user." } } } } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/divisions/": { "post": { "summary": "Create Division", "tags": [ "Manage Users" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Unique name assigned to division." }, "users": { "type": "array", "items": { "type": "string" }, "uniqueItems": true, "description": "List of users' work emails assigned to division." }, "employer_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true, "description": "List of employer IDs assigned to division." } }, "required": [ "name", "users", "employer_ids" ] }, "examples": { "division": { "value": { "name": "Sample Division", "users": [ "demo1@bnchmrk.com", "demo2@bnchmrk.com", "demo3@bnchmrk.com" ], "employer_ids": [ "f5635638-1fcd-44d3-9823-d97846774a1a", "81c9bbfc-b683-48cc-b923-4d8ba0483331", "a47372a0-51ab-4be4-a269-59d638e9fccd", "2a0183c8-e8e5-4da4-9806-9cd545e3a2d5" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of division." }, "name": { "type": "string", "description": "Unique name assigned to division." }, "users": { "type": "array", "items": { "type": "string" }, "uniqueItems": true, "description": "List of users' work emails assigned to division." }, "employer_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true, "description": "List of employer IDs assigned to division." } }, "required": [ "name", "users", "employer_ids" ] } } } }, "400": { "description": "Bad request / invalid data", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "array", "description": "List of data validation errors for 'name' field.", "items": { "type": "string" } }, "users": { "type": "array", "description": "List of data validation errors for 'users' field.", "items": { "type": "string" } }, "employer_ids": { "type": "array", "description": "List of data validation errors for 'employer_ids' field.", "items": { "type": "string" } } } } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/divisions/{divisionID}/": { "get": { "summary": "Get Division by ID", "tags": [ "Manage Users" ], "parameters": [ { "$ref": "#/components/parameters/divisionID" } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of division." }, "name": { "type": "string", "description": "Unique name assigned to division." }, "users": { "type": "array", "items": { "type": "string" }, "uniqueItems": true, "description": "List of users' work emails assigned to division." }, "employer_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true, "description": "List of employer IDs assigned to division." } }, "required": [ "name", "users", "employer_ids" ] } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } }, "put": { "summary": "Update Division", "tags": [ "Manage Users" ], "parameters": [ { "$ref": "#/components/parameters/divisionID" } ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Unique name assigned to division." }, "users": { "type": "array", "items": { "type": "string" }, "uniqueItems": true, "description": "List of users' work emails assigned to division." }, "employer_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true, "description": "List of employer IDs assigned to division." } }, "required": [ "name", "users", "employer_ids" ] }, "examples": { "division": { "value": { "name": "Sample Division", "users": [ "demo1@bnchmrk.com", "demo2@bnchmrk.com", "demo3@bnchmrk.com" ], "employer_ids": [ "f5635638-1fcd-44d3-9823-d97846774a1a", "81c9bbfc-b683-48cc-b923-4d8ba0483331", "a47372a0-51ab-4be4-a269-59d638e9fccd", "2a0183c8-e8e5-4da4-9806-9cd545e3a2d5" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of division." }, "name": { "type": "string", "description": "Unique name assigned to division." }, "users": { "type": "array", "items": { "type": "string" }, "uniqueItems": true, "description": "List of users' work emails assigned to division." }, "employer_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true, "description": "List of employer IDs assigned to division." } }, "required": [ "name", "users", "employer_ids" ] } } } }, "400": { "description": "Bad request / invalid data", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "array", "description": "List of data validation errors for 'name' field.", "items": { "type": "string" } }, "users": { "type": "array", "description": "List of data validation errors for 'users' field.", "items": { "type": "string" } }, "employer_ids": { "type": "array", "description": "List of data validation errors for 'employer_ids' field.", "items": { "type": "string" } } } } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } }, "delete": { "summary": "Delete Division", "tags": [ "Manage Users" ], "parameters": [ { "$ref": "#/components/parameters/divisionID" } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Success." }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/divisions/byEmployer/{employerID}/": { "get": { "summary": "Get Division by Employer ID", "tags": [ "Manage Users" ], "parameters": [ { "$ref": "#/components/parameters/employerID" } ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of division." }, "name": { "type": "string", "description": "Unique name assigned to division." }, "users": { "type": "array", "items": { "type": "string" }, "uniqueItems": true, "description": "List of users' work emails assigned to division." }, "employer_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true, "description": "List of employer IDs assigned to division." } }, "required": [ "name", "users", "employer_ids" ] } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/divisions/list/": { "get": { "summary": "Get Divisions List", "tags": [ "Manage Users" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of division." }, "name": { "type": "string", "description": "Unique name assigned to division." } } } } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/divisions/{divisionID}/addUser/": { "post": { "summary": "Add User to Division", "tags": [ "Manage Users" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "User's work email address." } }, "required": [ "email" ] }, "examples": { "user": { "value": { "email": "demo_user@bnchmrk.com" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of division." }, "name": { "type": "string", "description": "Unique name assigned to division." }, "users": { "type": "array", "items": { "type": "string" }, "uniqueItems": true, "description": "List of users' work emails assigned to division." }, "employer_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true, "description": "List of employer IDs assigned to division." } }, "required": [ "name", "users", "employer_ids" ] } } } }, "400": { "description": "Bad request / invalid data", "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "array", "description": "List of data validation errors for 'email' field.", "items": { "type": "string" } } } } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } }, "/divisions/{divisionID}/removeUser/": { "post": { "summary": "Remove User from Division", "tags": [ "Manage Users" ], "security": [ { "ApiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "User's work email address." } }, "required": [ "email" ] }, "examples": { "user": { "value": { "email": "demo_user@bnchmrk.com" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique ID assigned by Bnchmrk on creation of division." }, "name": { "type": "string", "description": "Unique name assigned to division." }, "users": { "type": "array", "items": { "type": "string" }, "uniqueItems": true, "description": "List of users' work emails assigned to division." }, "employer_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true, "description": "List of employer IDs assigned to division." } }, "required": [ "name", "users", "employer_ids" ] } } } }, "400": { "description": "Bad request / invalid data", "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "array", "description": "List of data validation errors for 'email' field.", "items": { "type": "string" } } } } } } }, "401": { "description": "Unauthorized." }, "404": { "description": "Resource not found." } } } } }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "Enter the token with the 'Token: ' prefix, e.g. 'Token abcde12345'" } }, "parameters": { "employerID": { "in": "path", "name": "employerID", "required": true, "description": "UUID of the target employer.", "schema": { "type": "string" } }, "planID": { "in": "path", "name": "planID", "required": true, "description": "UUID of the target plan.", "schema": { "type": "string" } }, "userID": { "in": "path", "name": "userID", "required": true, "description": "UUID of the target user.", "schema": { "type": "string" } }, "email": { "in": "path", "name": "email", "required": true, "description": "Work email of the target user.", "schema": { "type": "string" } }, "divisionID": { "in": "path", "name": "divisionID", "required": true, "description": "UUID of the target division.", "schema": { "type": "string" } } } } }