# QuoteConnect API **Environments:**
EnvironmentURL
Staginghttps://api.ichra-staging.healthsherpa.com
Productionhttps://api.ichra.healthsherpa.com
**FIPS Code Lookup** See [FIPS County Codes](https://docs.ichra.healthsherpa.com/api-reference/supporting-material/fips-county-codes) for what the `fip_code` value is and how to look it up from a zip code. **Exchange and Enrollability Notes** * Quoting supports on-ex and off-ex. * Use `off_ex: true` for off-ex-only quoting. * If `include_non_enrollable_offex: true` is passed, returned plans can include non-enrollable off-ex plans. * Use `api_enrollment` and `deeplink_enrollment` response flags to determine which enrollment path each plan supports. See [Enrollment Decision Path](https://docs.ichra.healthsherpa.com/integration-guide/enrollment-decision-path). If next step is enrollment: * Validate plan enrollability before attempting Deeplink or EnrollConnect. *** #### Plan Quotes ## Get health insurance plan quotes > Fetch health insurance plans based on location, household details, and filtering criteria ```json {"openapi":"3.0.0","info":{"title":"Health Insurance Quotes API","version":"1.0.0"},"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"API authentication token (required for production). These will be generated as needed and shared with you to use."}},"schemas":{"QuotesRequest":{"type":"object","description":"Request body for POST /api/v1/quotes endpoint","required":["zip_code","fip_code","applicants"],"properties":{"zip_code":{"type":"string","description":"ZIP code for the location"},"fip_code":{"type":"string","description":"County code (FIPS) for the location"},"applicants":{"type":"array","description":"List of household members applying for coverage","items":{"type":"object","required":["age","relationship","smoker"],"properties":{"age":{"type":"integer","description":"Age of the applicant","minimum":1},"relationship":{"type":"string","description":"Relationship to the primary applicant","enum":["primary","spouse","dependent"]},"smoker":{"type":"boolean","description":"Whether the applicant is a smoker"}}}},"household_income":{"type":"number","description":"Annual household income. Only required if the client wants subsidy information included in the result.","minimum":0},"state":{"type":"string","description":"State abbreviation","maxLength":2},"plan_year":{"type":"integer","description":"Plan year","minimum":2020},"current_page":{"type":"integer","description":"Current page number for pagination","minimum":1,"default":1},"per_page":{"type":"integer","description":"Number of results per page (max 500)","minimum":1,"maximum":500,"default":20},"filter":{"description":"Specifies which plan fields to include in the response. Only the requested \nfields (plus always-included fields: name, year, hios_id, gross_premium) \nwill be returned for each plan. Can be provided as an array or \ncomma-separated string.\n","oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"dental_search":{"type":"boolean","description":"Whether to include dental plans in search"},"sort":{"type":"string","description":"Sort order for results","enum":["premium_asc","premium_desc","deductible_asc","deductible_desc","moop_asc","moop_desc"]},"add_attributes":{"type":"boolean","description":"When true, includes an `attributes` array on each plan with comparative rankings (good/bad/avg) across cost and feature categories."},"utilization":{"type":"string","description":"Healthcare usage level for cost modeling. Affects `attributes` rankings. Only meaningful when `add_attributes` is true.","enum":["low","medium","high"]},"all_benefits":{"type":"boolean","description":"When true, returns the full SBC benefit list. Default returns a curated subset of commonly compared benefits."},"all_details":{"type":"boolean","description":"When true, includes `cost_sharing_tiers` with per-tier (in-network, in-network tier 2, out-of-network) deductible, MOOP, and coinsurance breakdowns."},"off_ex":{"type":"boolean","description":"Return only off-exchange plans. Otherwise, will only return on-exchange plans."},"include_non_enrollable_offex":{"type":"boolean","description":"If true, includes off-exchange plans the are not enrollable on HealthSherpa.","default":false},"networks":{"type":"array","description":"Filter by network types","items":{"type":"string","enum":["HMO","PPO","EPO","POS","Indemnity"]}},"metal_levels":{"type":"array","description":"Filter by metal levels","items":{"type":"string","enum":["Bronze","Silver","Gold","Platinum","Catastrophic"]}},"issuer_hios_ids":{"type":"array","description":"Filter by specific issuer HIOS IDs","items":{"type":"string"}}}},"Plan":{"type":"object","description":"Health insurance plan details","properties":{"id":{"type":"string","description":"Unique plan identifier"},"hios_id":{"type":"string","description":"Health Insurance Oversight System ID"},"name":{"type":"string","description":"Plan name"},"issuer":{"type":"object","description":"Issuer information","properties":{"name":{"type":"string","description":"Insurance company name"},"hios_id":{"type":"string","description":"Issuer HIOS ID"},"state":{"type":"string","description":"State abbreviation"},"payment_phone":{"type":"string","nullable":true,"description":"Payment phone number"},"customer_service_phone":{"type":"string","nullable":true,"description":"Customer service phone number"},"logo_url":{"type":"string","nullable":true,"description":"URL to the issuer's logo image"},"eap_disabled":{"type":"boolean","description":"Whether Employee Assistance Program is disabled"}}},"metal_level":{"type":"string","description":"Plan metal level"},"is_easy_pricing_plan":{"type":"boolean","description":"Whether this is an easy pricing plan"},"plan_type":{"type":"string","description":"Plan type (same as network_type)"},"network_type":{"type":"string","enum":["HMO","PPO","EPO","POS","Indemnity"],"description":"Network type"},"adult_medical":{"type":"boolean","description":"Whether plan covers adult medical"},"child_medical":{"type":"boolean","description":"Whether plan covers child medical"},"adult_dental":{"type":"boolean","description":"Whether plan covers adult dental"},"child_dental":{"type":"boolean","description":"Whether plan covers child dental"},"referral_required_for_specialist":{"type":"boolean","nullable":true,"description":"Whether referral is required for specialist visits"},"hsa_eligible":{"type":"boolean","nullable":true,"description":"Whether plan is HSA eligible"},"state":{"type":"string","description":"State abbreviation"},"dental_only":{"type":"boolean","description":"Whether this is a dental-only plan"},"estimated_rate":{"type":"boolean","description":"Whether the rate is estimated"},"ichra_only":{"type":"boolean","description":"Whether this plan is only available to individuals with an ICHRA offer from their employer."},"networks":{"type":"array","description":"Network information","items":{"type":"object","properties":{"id":{"type":"integer","description":"Network ID"},"name":{"type":"string","description":"Network name"},"year":{"type":"integer","description":"Plan year"},"issuer_network_id":{"type":"string","description":"Issuer's network identifier"}}}},"year":{"type":"integer","description":"Plan year"},"dentist_network_url":{"type":"string","nullable":true,"description":"URL for dentist network information"},"csr_code":{"type":"string","description":"Cost Sharing Reduction code"},"rating":{"type":"object","description":"Plan rating information","properties":{"hios_issuer_id":{"type":"string","description":"HIOS issuer ID"},"state":{"type":"string","description":"State abbreviation"},"plan_type":{"type":"string","description":"Plan type"},"plan_year":{"type":"integer","description":"Plan year"},"global_rate":{"type":"integer","description":"Global rating"},"s1_rate":{"type":"integer","description":"S1 rating"},"s2_rate":{"type":"integer","description":"S2 rating"},"s3_rate":{"type":"integer","description":"S3 rating"}}},"cost_sharing":{"type":"object","description":"Cost sharing details","properties":{"network_tier":{"type":"string"},"csr_type":{"type":"string"},"medical_ded_ind":{"type":"string"},"medical_ded_fam":{"type":"string","nullable":true},"drug_ded_ind":{"type":"string","nullable":true},"drug_ded_fam":{"type":"string","nullable":true},"medical_moop_ind":{"type":"string"},"medical_moop_fam":{"type":"string"},"drug_moop_ind":{"type":"string","nullable":true},"drug_moop_fam":{"type":"string","nullable":true},"medical_coins":{"type":"string","nullable":true},"drug_coins":{"type":"string","nullable":true},"pcp_visit_free_count":{"type":"integer"},"pcp_visit_ded_coins_begins_count":{"type":"integer"}}},"csr_level":{"type":"string","description":"Cost Sharing Reduction level"},"cost_sharing_pretty":{"type":"object","description":"Human-readable cost sharing information","properties":{"csr_type":{"type":"string"},"ded_med_ind":{"type":"string"},"oop_med_ind":{"type":"string"},"oop_med_fam":{"type":"string"}}},"benefits":{"type":"object","description":"Cost-sharing description per benefit. Curated subset by default; full SBC list when `all_benefits=true`.","additionalProperties":{"type":"string"}},"benefits_with_tier_2":{"type":"object","description":"Whether each benefit has separate in-network tier 2 cost-sharing.","additionalProperties":{"type":"boolean"}},"benefits_pretty":{"type":"object","description":"Benefit cost-sharing broken down by deductible phase.","additionalProperties":{"type":"object","properties":{"original":{"type":"string","description":"Raw cost-sharing text from the SBC"},"before":{"type":"string","description":"Member cost before meeting the deductible"},"after":{"type":"string","description":"Member cost after meeting the deductible"}}}},"urls":{"type":"object","description":"Related URLs","properties":{"network":{"type":"string","nullable":true,"description":"Network provider directory URL"},"benefits":{"type":"string","nullable":true,"description":"Benefits information URL"},"formulary":{"type":"string","nullable":true,"description":"Formulary URL"},"brochure":{"type":"string","nullable":true,"description":"Plan brochure URL"}}},"cost_sharing_tiers":{"type":"object","description":"Per-tier cost-sharing breakdowns. Populated when `all_details=true`.","properties":{"inn":{"type":"object","description":"In-network (primary tier)"},"inn2":{"oneOf":[{"type":"object"},{"type":"string"}],"description":"In-network tier 2. Returns \"No data available\" when the plan has no secondary tier."},"oon":{"type":"object","description":"Out-of-network"}}},"benefits_explanations":{"type":"object","description":"Carrier-provided supplementary notes for specific benefits. Null when no note is available.","additionalProperties":{"type":"string","nullable":true}},"gross_premium":{"type":"number","format":"float","description":"Gross premium amount before subsidies"},"ehb_premium":{"type":"number","format":"float","description":"Essential Health Benefits premium amount"},"subsidy_applied":{"type":"number","format":"float","description":"Subsidy amount applied"},"premium":{"type":"number","format":"float","description":"Final premium amount after subsidies"},"gross_premium_per_applicant":{"type":"object","description":"Premium breakdown per applicant","properties":{"dependents":{"type":"array","items":{"type":"object"}},"non_dependents":{"type":"object","additionalProperties":{"type":"number"}},"excluded_dependents":{"type":"integer"}}},"attributes":{"type":"array","description":"Comparative plan rankings across cost and feature categories. Only included when `add_attributes=true`.","items":{"type":"object","properties":{"text":{"type":"string","description":"Human-readable ranking label"},"type":{"type":"string","enum":["good","bad","avg"],"description":"Favorable (good), unfavorable (bad), or average (avg) relative to other plans"},"rank":{"type":"integer","nullable":true,"description":"Position within the category (1 = best). Null for boolean attributes."},"total":{"type":"integer","description":"Total plans ranked in this category"},"value":{"oneOf":[{"type":"number"},{"type":"boolean"},{"type":"array"}],"description":"Raw value. Numeric for costs, boolean for features, [premium, deductible] array for premium category."},"category":{"type":"string","description":"Category identifier (e.g., premium, deductible, moop, worst_case, primary_care_cost, specialist_cost, generic_drug)."}}}},"providers":{"type":"array","description":"Provider information","items":{"type":"object"}},"drugs":{"type":"array","description":"Drug coverage information","items":{"type":"object"}},"prescriptions":{"type":"object","description":"Prescription information","additionalProperties":true},"medicaid_eligible_applicants":{"type":"array","description":"Medicaid eligible applicants","items":{"type":"object"}},"deductible":{"type":"number","format":"float","description":"Annual deductible amount (legacy field, use cost_sharing for detailed info)"},"moop":{"type":"number","format":"float","description":"Maximum out-of-pocket amount (legacy field, use cost_sharing for detailed info)"},"issuer_name":{"type":"string","description":"Insurance company name (legacy field, use issuer.name)"}},"required":["hios_id","name","premium","metal_level"]},"Meta":{"type":"object","properties":{"result_count":{"type":"integer","description":"total number of results"},"zip_code":{"type":"string","description":"zip code used for the quote. In the response when no results are returned."},"fip_code":{"type":"string","description":"fip code used for the quote. In the response when no results are returned."},"message":{"type":"string","description":"message to the user when no results are returned."}},"required":["result_count"]}}},"paths":{"/api/v1/quotes":{"post":{"summary":"Get health insurance plan quotes","description":"Fetch health insurance plans based on location, household details, and filtering criteria","operationId":"getQuotes","tags":["Quotes"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuotesRequest"}}}},"responses":{"200":{"description":"Successfully retrieved plan quotes","content":{"application/json":{"schema":{"type":"object","properties":{"plans":{"type":"array","items":{"$ref":"#/components/schemas/Plan"}},"meta":{"$ref":"#/components/schemas/Meta"}}}}}},"401":{"description":"Unauthorized - missing or invalid API token","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"422":{"description":"Bad Request - Invalid parameters","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}}}}} ``` #### Response Shaping Parameters These optional parameters control what data is included for each plan in the response. By default, the response returns core plan metadata, summary cost data, and a curated subset of benefits. Use these flags to request richer data when your UI needs it. **`add_attributes` (boolean)** When `true`, each plan includes an `attributes` array with comparative rankings across categories: premium, deductible, MOOP, worst-case cost, primary care cost, specialist cost, ER cost, hospital stay cost, generic drug cost, brand drug cost, child dental, and HSA eligibility. Each attribute contains: | Field | Description | | ---------- | ---------------------------------------------------------------------------------------------------------- | | `text` | Human-readable label (e.g., "Low monthly premium payment") | | `type` | `good`, `bad`, or `avg` relative to other plans in the result set | | `rank` | This plan's position in the category (1 = best). Null for boolean attributes. | | `total` | Total plans ranked in this category | | `value` | Raw value: numeric for costs, boolean for features, `[premium, deductible]` array for the premium category | | `category` | Category identifier (e.g., `premium`, `deductible`, `worst_case`, `primary_care_cost`) | **`utilization` (low / medium / high)** Sets the assumed healthcare usage level for cost modeling. This affects the `attributes` rankings and estimated cost calculations: * **`low`** - Minimal doctor visits and prescriptions * **`medium`** - Moderate usage * **`high`** - Frequent visits, specialist care, and prescriptions Only meaningful when `add_attributes` is `true`. The utilization level changes which plans rank as "good" or "bad" for cost categories like worst-case costs, per-visit costs, and drug costs. **`all_benefits` (boolean)** Controls the breadth of benefit data returned in `benefits`, `benefits_pretty`, `benefits_with_tier_2`, and `benefits_explanations`. * **`false` (default)** - Returns a curated subset of commonly compared benefits (PCP visit, specialist, ER, generic drugs, imaging, etc.) * **`true`** - Returns the complete set of covered benefits from the plan's Summary of Benefits and Coverage (SBC), including mental health, rehab, lab work, durable medical equipment, and all other categories. The `benefits_pretty` object breaks down each benefit into: | Field | Description | | ---------- | ----------------------------------------------------------------------- | | `original` | Raw cost-sharing text from the SBC | | `before` | What the member pays before meeting the deductible (e.g., "Full price") | | `after` | What the member pays after the deductible (e.g., "20%", "$30 copay") | **`all_details` (boolean)** Controls the depth of cost-sharing data returned. * **`false` (default)** - Returns summary-level cost data in `cost_sharing` and the legacy `deductible`/`moop` fields. * **`true`** - Populates `cost_sharing_tiers` with full breakdowns for each network tier: * `inn` - In-network (primary tier) * `inn2` - In-network tier 2 (returns `"No data available"` when the plan has no secondary tier) * `oon` - Out-of-network Each tier includes individual/family deductibles, MOOP, and coinsurance for both medical and drug categories. *** #### ICHRA-Only Plans Plans may be flagged with `ichra_only: true` when they are only available to individuals who have been offered an ICHRA by their employer. When displaying plans to users who have not been offered an ICHRA, filter these out. *** #### Issuer Logo The `issuer` object includes a `logo_url` field containing a URL to the carrier's logo image. Use this to display carrier branding in your plan comparison UI. *** #### APTC Estimation Estimate Advance Premium Tax Credit (APTC) eligibility for a household. This is useful for affordability modeling and contribution strategy analysis. {% hint style="info" %} If you are already calling `POST /quotes` with `household_income`, the quote response includes subsidy information. The APTC Estimator is useful when you need a standalone subsidy estimate without retrieving full plan data. {% endhint %} ## Create APTC estimate > Fetch an APTC estimate based on household information ```json {"openapi":"3.0.0","info":{"title":"APTC Estimates API","version":"1.0.0"},"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"API authentication token (required for production). These will be generated as needed and shared with you to use. Use of our Mock CRM page does not require this header."}}},"paths":{"/api/v1/aptc_estimates":{"post":{"summary":"Create APTC estimate","description":"Fetch an APTC estimate based on household information","operationId":"createAptcEstimate","tags":["APTC Estimates"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["zip_code","fip_code","household_income","applicants"],"properties":{"zip_code":{"type":"string","description":"Zip code of the household"},"fip_code":{"type":"string","description":"FIPS code for the location"},"household_income":{"type":"number","format":"float","description":"Annual household income in USD"},"plan_year":{"type":"integer","description":"Year of the plan (optional)"},"applicants":{"type":"array","description":"List of household members applying for coverage","items":{"type":"object","required":["age","relationship","smoker"],"properties":{"age":{"type":"integer","description":"Age of the applicant","minimum":1},"relationship":{"type":"string","description":"Relationship to the primary applicant","enum":["primary","spouse","dependent"]},"smoker":{"type":"boolean","description":"Whether the applicant is a smoker"}}}}}}}}},"responses":{"200":{"description":"Successful APTC estimate","content":{"application/json":{"schema":{"type":"object","description":"APTC estimate details","properties":{"estimated_aptc":{"type":"number","format":"float","description":"Estimated Advanced Premium Tax Credit amount in USD. \nThis is the monthly subsidy amount that can be applied to premiums.\nReturns 0 if no plans with subsidy are found.\n"},"csr_level":{"type":"string","description":"Cost Sharing Reduction (CSR) level code. Represents the highest CSR level \navailable based on the household's income and plan selection.\n","enum":["00","01","02","03","04","05","06"]}},"required":["estimated_aptc","csr_level"]}}}},"401":{"description":"Unauthorized - missing or invalid API token","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"422":{"description":"Bad request - missing or invalid parameters","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}}}}} ``` #### Plan Lookup Retrieve plan details, enrollment flags, and attestation content for a single plan by HIOS ID. ``` GET /api/v1/plans/:hios_id?plan_year=2026 ```
ParameterInRequiredDescription
hios_idpathYes14-character HIOS plan ID
plan_yearqueryNoDefaults to the current plan year
includequeryNoComma-separated list of additional data. Supported: enrollment_requirements
The response includes the same plan fields as the quotes response (with `all_benefits` and `all_details` always enabled), plus: * `deeplink_enrollment` / `api_enrollment` - enrollment path availability * `enrollment_requirements` - carrier-specific attestation content (when requested via `include=enrollment_requirements`) **Enrollment Requirements** When `include=enrollment_requirements` is passed, the response includes an `enrollment_requirements` object containing attestation text that your platform must present to applicants during enrollment: ```json { "plan": { "hios_id": "53901AZ1490005", "deeplink_enrollment": true, "api_enrollment": true, "enrollment_requirements": { "attestations": { "agrees_issuer_attestations": { "content": "By signing below, I certify..." }, "electronic_signature_consent": { "content": "%{signature_name}, type your full name to sign electronically." }, "broker_signature_attestation": { "content": "I attest that I have reviewed the application..." }, "pediatric_dental": { "content": "I understand that pediatric dental coverage...", "options": ["purchased_separately", "not_applicable"] }, "state_supplement_primary_signature": { "content": ["Paragraph 1...", "Paragraph 2..."] }, "state_supplement_spouse_signature": { "content": ["Paragraph 1..."] }, "state_supplement_disclosures_signature": { "content": "State-specific disclosure text..." } } } } } ``` Keys that are absent or `null` indicate the attestation is not required for this carrier/state combination. Display the `content` value in your UI, then pass the corresponding field in the `attestations` or `signatures` object of the EnrollConnect application request. {% hint style="warning" %} The `electronic_signature_consent` content may contain `%{signature_name}`. Replace this placeholder with the applicant's full legal name before displaying the text. All other placeholders (carrier name, etc.) are resolved server-side. {% endhint %} ## Get plan details by HIOS ID > Retrieve plan data and enrollment flags for a single plan. Use this to\ > confirm which enrollment path a plan supports. Pass\ > \`include=enrollment\_requirements\` to also retrieve carrier-specific\ > attestation content your UI must present during enrollment.
```json {"openapi":"3.0.0","info":{"title":"Plan Lookup API","version":"0.1.0-preview"},"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"PlanResponse":{"type":"object","properties":{"plan":{"type":"object","properties":{"hios_id":{"type":"string","description":"14-character HIOS plan ID."},"name":{"type":"string","description":"Plan display name."},"year":{"type":"integer","description":"Plan year."},"state":{"type":"string","description":"Two-letter state code."},"metal_level":{"type":"string","enum":["catastrophic","bronze","expanded_bronze","silver","gold","platinum"],"description":"ACA metal tier."},"plan_type":{"type":"string","description":"Network type (e.g., PPO, HMO, EPO)."},"network_type":{"type":"string","description":"Network classification."},"hsa_eligible":{"type":"boolean","description":"Whether the plan is HSA-eligible."},"dental_only":{"type":"boolean","description":"Whether this is a standalone dental plan."},"is_easy_pricing_plan":{"type":"boolean"},"estimated_rate":{"type":"number","format":"float","description":"Monthly premium estimate."},"deductible":{"type":"string","description":"Formatted deductible amount."},"moop":{"type":"string","description":"Formatted maximum out-of-pocket."},"issuer":{"type":"object","properties":{"name":{"type":"string"},"hios_id":{"type":"string"},"logo_url":{"type":"string","format":"uri","description":"URL to the issuer's logo image."}}},"issuer_name":{"type":"string","description":"Issuer display name (top-level convenience field)."},"referral_required_for_specialist":{"type":"boolean"},"csr_code":{"type":"string"},"csr_level":{"type":"string"},"rating":{"type":"object","description":"Quality rating data when available."},"urls":{"type":"object","description":"Links to SBC, formulary, and provider directory."},"networks":{"type":"array","items":{"type":"object"},"description":"Network details."},"cost_sharing":{"type":"object","description":"Summary cost-sharing data."},"cost_sharing_pretty":{"type":"object","description":"Formatted cost-sharing for display."},"cost_sharing_tiers":{"type":"object","description":"Detailed cost-sharing broken out by in-network and out-of-network tiers."},"benefits":{"type":"array","items":{"type":"object"},"description":"Full SBC benefit details (always included for plan lookup)."},"benefits_with_tier_2":{"type":"array","items":{"type":"object"},"description":"Benefits with secondary tier cost-sharing."},"benefits_pretty":{"type":"array","items":{"type":"object"},"description":"Formatted benefit summaries for display."},"benefits_explanations":{"type":"array","items":{"type":"object"},"description":"Carrier-provided benefit explanatory text."},"attributes":{"type":"array","items":{"type":"object"},"description":"Plan attribute tags (e.g., national coverage, telehealth)."},"deeplink_enrollment":{"type":"boolean","description":"Whether the plan supports enrollment via Application Deeplink."},"api_enrollment":{"type":"boolean","description":"Whether the plan supports enrollment via EnrollConnect API."},"enrollment_requirements":{"$ref":"#/components/schemas/EnrollmentRequirements"}}}}},"EnrollmentRequirements":{"type":"object","description":"Carrier-specific enrollment requirements. Only included when `include=enrollment_requirements` is passed.","properties":{"attestations":{"$ref":"#/components/schemas/Attestations"}}},"Attestations":{"type":"object","nullable":true,"description":"Carrier- and state-specific attestation text that platforms must present\nto applicants during enrollment. Keys that are absent or null indicate\nthe attestation is not required for this carrier/state/plan combination.\nDisplay the `content` value in your UI and pass the corresponding field\nin the `attestations` or `signatures` object of the EnrollConnect\napplication request.\n\n**Placeholder**: The `electronic_signature_consent` content may contain\n`%{signature_name}`. Replace this with the applicant's full legal name\nbefore displaying the text. All other placeholders (carrier name, etc.)\nare resolved server-side.\n","properties":{"agrees_issuer_attestations":{"type":"object","nullable":true,"description":"Carrier-specific general attestation. Maps to `attestations.agrees_issuer_attestations` (boolean) in the application request.","properties":{"content":{"type":"string","description":"Attestation text to display."}}},"electronic_signature_consent":{"type":"object","description":"E-signature consent prompt. Maps to `attestations.electronic_signature_consent` (boolean) in the application request.","properties":{"content":{"type":"string","description":"Consent text. May contain `%{signature_name}` placeholder."}}},"pediatric_dental":{"type":"object","nullable":true,"description":"Pediatric dental attestation. Maps to `attestations.pediatric_dental` (string) in the application request.","properties":{"content":{"type":"string","description":"Attestation text to display."},"options":{"type":"array","items":{"type":"string"},"description":"Valid option values the applicant can select."}}},"broker_signature_attestation":{"type":"object","nullable":true,"description":"Broker consent attestation. Maps to `attestations.broker_signature_attestation` (boolean) in the application request.","properties":{"content":{"type":"string","description":"Attestation text to display to the broker/agent."}}},"state_supplement_primary_signature":{"type":"object","nullable":true,"description":"State addendum for the primary applicant. Maps to `signatures.state_supplement_primary_applicant_signature` (string) in the application request.","properties":{"content":{"type":"array","items":{"type":"string"},"description":"Paragraphs of state-specific attestation text."}}},"state_supplement_spouse_signature":{"type":"object","nullable":true,"description":"State addendum for the spouse. Maps to `signatures.state_supplement_spouse_signature` (string) in the application request.","properties":{"content":{"type":"array","items":{"type":"string"},"description":"Paragraphs of state-specific attestation text."}}},"state_supplement_disclosures_signature":{"type":"object","nullable":true,"description":"State-specific disclosure. Maps to `signatures.state_supplement_disclosures_signature` (string) in the application request.","properties":{"content":{"type":"string","description":"Disclosure text to display."}}}}},"ErrorResponse":{"type":"object","properties":{"error":{"type":"string","description":"Error message."}}}}},"paths":{"/api/v1/plans/{hios_id}":{"get":{"summary":"Get plan details by HIOS ID","description":"Retrieve plan data and enrollment flags for a single plan. Use this to\nconfirm which enrollment path a plan supports. Pass\n`include=enrollment_requirements` to also retrieve carrier-specific\nattestation content your UI must present during enrollment.\n","operationId":"getPlan","tags":["Plans"],"parameters":[{"name":"hios_id","in":"path","required":true,"schema":{"type":"string"},"description":"14-character HIOS plan ID."},{"name":"plan_year","in":"query","required":false,"schema":{"type":"integer"},"description":"Plan year. Defaults to the current plan year if omitted."},{"name":"include","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of additional data to include.\nSupported values: `enrollment_requirements`.\n"}],"responses":{"200":{"description":"Plan details with enrollment flags. Includes `enrollment_requirements` when requested via `include` parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanResponse"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Plan not found or no data for the requested plan year.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Invalid plan year.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.ichra.healthsherpa.com/api-reference/endpoints/quoteconnect-api.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.