Skip to main content

B2B Data Externalization Program – API Overview

Small Business Quoting APIs and Benefit Administration APIs

This user-friendly guide outlines UnitedHealthcare’s B2B Data Externalization APIs in two categories: Shopping & Quoting APIs and Benefit Administration APIs. Each API entry describes what it does, how it benefits external users (brokers, partners, benefit administrators), and key technical details (real-time vs. batch, production status, scope of products/platforms). The tone is professional yet accessible, avoiding internal jargon, to ensure anyone can understand the capabilities without deep technical knowledge.

Shopping & Quoting APIs​

APIs used during the new business “shopping” and quote generation process for small employer groups (e.g. to retrieve plan options, benefits, and rates). These services cover UHC’s small business insurance products – medical, dental, vision, basic life, etc., including UnitedHealthcare Fully Insured, Level Funded and regional Oxford plans. All Shopping & Quoting APIs are real-time (instant response) unless noted, and as of April 2024 they are live in production for external partner use.

  • Get Plan Availability by ZIP Code – (Real-time & Bulk, Live) – Retrieves all small business insurance plans available for a given geographic area, based on state and ZIP code.

    • Benefit: Enables external quoting tools to quickly find every plan option (medical, dental, vision, life, etc.) that a client is eligible for in their location. This ensures brokers show only the plans the customer can actually purchase, filtered by location.

  • Get Plan Benefits by State – (Real-time & Bulk, Live) – Provides plan benefit details and availability by state and coverage type. In other words, given a U.S. state, the API returns the plan offerings (and their key benefit highlights) for that state across different product lines (medical, dental, vision, etc.).

    • Benefit: Allows partners to see and compare the features of plans available in a particular state. This helps brokers explain plan options to clients (e.g., “What does Plan X cover in this state?”) using accurate, state-specific information.

  • Get Plan Rates by Group – (Real-time, Live) – Delivers pricing (premium rates) for available plans for a specific customer profile. The request includes details like the group’s location (state, ZIP, possibly county) and census information (e.g., ages or number of employees), and the API responds with the list of plans with their calculated rates.

    • Benefit: Powers instant quote generation. A broker’s system can input client data and immediately get back monthly premiums for each plan option, without manual calculations or delays, allowing brokers to quickly provide price quotes to small business clients.

  • Get Benefit Collateral – (Real-time, Live) – Provides official plan documents for the plans being quoted. This typically includes pre-sale materials like the Summary of Benefits and Coverage (SBC), Summary of Coverage, Benefit Summaries, and other marketing collateral PDFs for each plan.

    • Benefit: Automates access to up-to-date plan documentation. After or during quoting, an external platform can call this API to fetch the exact plan brochures and summaries that a client would need to review. This saves time for brokers (no need to manually search for PDFs) and ensures clients get accurate, approved documents for every plan they’re considering.

  • Get Footnotes – (Real-time, Live) – Returns any disclaimers, footnotes, or special instructions relevant to the quote scenario or plans selected. For example, it provides underwriting guidelines, state-specific notices, participation requirements, or other conditions that normally appear as fine print in a quote.

    • Benefit: Helps external platforms maintain compliance and transparency. By including this data, the partner’s quoting output will display all the necessary fine-print and caveats (just as UHC’s internal systems would), so the client and broker are fully informed of any requirements or limitations associated with the quote.

  • Get County by ZIP – (Real-time, Live) – A small utility API that given a ZIP code, returns the corresponding county (or counties).

    • Benefit: Ensures geographic accuracy for quoting. Some insurance plans or rates depend on the county of the group’s address (not just state/ZIP). This API helps the quoting system automatically determine the county, which can then be used to filter plan availability or adjust rates precisely. It removes the guesswork when a ZIP code spans multiple counties and helps produce an accurate quote tailored to the employer’s exact location.

  • Proposal Quote Submission – (Real-time, Live) – Submits a formal proposal quote to UHC and returns a Proposal ID (a reference number in UHC’s system). This is used when a quote is finalized as an official proposal for the client. The API takes the quote info and creates a corresponding record in UHC’s case installation system.

    • Benefit: Streamlines the transition from quote to sale. Once a client says “yes” to a quote, the partner can call this API to register that proposal in UHC’s internal system (with all the client’s info pre-loaded). This means that when it’s time to set up the new insurance policy, UHC already has the data on hand under that Proposal ID, avoiding re-keying of information and speeding up the onboarding of the new group.

  • Sold Case Installation Trigger – (Real-time, Live) – Notifies UHC’s systems that a quote has been sold (accepted) and initiates the new case installation process. In practice, once the Proposal ID (from the step above) is created, this API triggers UHC’s internal workflow to start setting up the new employer group’s coverage.

    • Benefit: Automates the hand-off from sales to implementation. For the external partner, this is a one-click way to say “this group is ready to onboard.” It kicks off creation of the group in UHC’s enrollment and billing systems, generation of member enrollment materials, etc., without waiting for manual intervention. This reduces delays and ensures a smooth experience from the broker’s final sale to the client’s coverage being activated.

  • Broker NPN Validation – (Real-time, Live) – An online validation service to verify a broker’s National Producer Number (NPN) and appointment with UHC before allowing them to quote or enroll. (This is often exposed as a lightweight API or web form.)

    • Benefit: Protects the process by ensuring only authorized, licensed brokers can use these quoting and enrollment tools. External platforms can integrate this check so that when a broker logs in or starts a quote, their credentials are confirmed. This prevents unappointed or unlicensed agents from obtaining rates or submitting business, maintaining compliance with regulations and UHC’s policies. It’s a quick automated gatekeeper step that simplifies broker management for UHC and its partners.

Benefit Administration APIs​

APIs used after a group is sold, to support ongoing enrollment and benefits administration for small business clients. These allow external benefit administration platforms (HR systems, enrollment websites, etc.) to exchange data with UHC in real-time, keeping employer and member information in sync. The goal is to eliminate manual eligibility files and provide a seamless post-sale experience (adds, terms, changes, renewals, etc.). Most Benefit Administration APIs are real-time; a few support bulk data loads or notifications. As of April 2024, many are live, with some advanced features planned later in 2024. (Note: These APIs apply to UHC’s fully insured small group products. Certain specialized plans, like the California NICE HMO, are out of scope.)

  • API Security & Marketplace Portal – (Web Portal, Live) – This is a secure onboarding and management portal for external partners to access UHC’s APIs. What it does: Provides a user-friendly website where partners can register for API access, obtain credentials (API keys, OAuth client IDs, etc.), and manage their integration settings. It also offers documentation and support for implementing the APIs.

    • Benefit: Makes it easy for an external developer or partner admin to get started and maintain their connection. Instead of ad-hoc emails or complex setups, everything needed to use UHC’s B2B APIs is available in one place. This ensures that data exchange is secure (only authorized parties get keys) and that partners have a smooth onboarding experience when integrating their systems with UHC.

  • Get Customer Detail – (Real-time API, Live) – Retrieves detailed information about an employer (customer) group in UHC’s system. When given a customer ID or similar identifier, it returns data such as the company name, group ID, address, products they’re enrolled in, group size, effective dates, etc.

    • Benefit: Allows external benefit administration platforms to pull in the official record for a group directly from UHC. For example, after a new group is installed, the partner can use this to populate their system with the client’s profile rather than relying on manual data entry. It ensures the partner’s records (and possibly what employer HR sees on their platform) match UHC’s records. This API is also useful for checking any updates to client info over time (like if the employer changed addresses or added a new line of coverage at renewal).

  • Get Eligibility Details – (Real-time API & Bulk File, Live) – Provides member enrollment and eligibility data for a group’s employees and dependents. There are two modes:

    • Real-time lookup: (Available now or upcoming) Query for one employee or a subset of members to get current coverage details (what plans they’re enrolled in, effective dates, etc.).

    • Bulk file (ECG format): A full eligibility list delivered as a batch file, typically used to download the entire roster of enrolled members for a customer.

      • Benefit: This gives partners flexibility in keeping enrollment data aligned. The bulk file can be used during implementation or for periodic audits – it brings over all members so the partner’s system starts with a complete, up-to-date enrollment list. The real-time API can be used day-to-day to verify individual records or small sets of data on the fly (e.g., “Is this employee currently active in coverage?”). Having both options means external administrators can both import all data initially and then stay in sync in real time, without waiting for nightly files or doing manual reconciliation.

  • Benefit Detail API – (Real-time API, Live) – Returns detailed benefit information for the plans that a specific group has. For a given customer and plan ID, it provides a full breakdown of the plan’s coverage details – for example, copay amounts, deductibles, out-of-pocket maximum, covered services, exclusions, etc., for medical, dental, vision, life coverage as applicable.

    • Benefit: Enables external platforms to display the exact benefits of the insurance plans to employers and members. If an employee is reviewing their coverage on a third-party benefits portal, that portal can call this API to show the up-to-date benefits straight from UHC’s source. This ensures consistency (the benefits information is accurate and identical to what UHC has on file) and helps answer questions about “What does my plan cover?” without the partner needing to manually maintain benefit summaries.

  • Member List API – (Batch API, Live) – Provides the full list of enrolled members (all employees and their dependents) for a given customer group in one bulk response or file. This typically returns each member’s personal info (name, DOB, etc.) and their coverage selections.

    • Benefit: Often used at the start of a partner’s engagement with a client or for large audits. For example, when a new benefits administration partner takes over a client that is already with UHC, they can use this to pull in every member that’s currently covered under the group’s policies. It saves tremendous time versus manually collecting enrollment spreadsheets. By loading this data into their system, the partner ensures they have a mirror of UHC’s enrollment data from day one. (This is usually done before enabling ongoing real-time updates, to ensure both systems are in sync.)

  • Member Lookup API – (Real-time API, Live) – Retrieves coverage details for a specific individual (or family) under the group. You can request by an individual member ID (which could return that employee and optionally their dependents) or other identifying info. The API responds with that person’s enrollment details: which plan(s) they’re on, coverage effective date, status (active/termed), etc.

    • Benefit: Supports quick, on-demand inquiries. If an HR administrator or support rep needs to verify one person’s coverage in real time (“Has this new hire’s enrollment gone through?” or “Is this employee’s spouse currently covered?”), the partner’s system can get the answer immediately via this API. It’s faster and more accurate than searching through files or calling support. This is very helpful for customer service interactions and for double-checking data before making changes (e.g., confirming someone isn’t already enrolled before adding them).

  • Enrollment & Eligibility Maintenance API – (Real-time API, Live) – Allows the external partner to send updates to UHC about member enrollment changes. This covers transactions like adding a new enrollee (e.g., a new hire or newly eligible dependent), terminating coverage for someone, or updating a member’s details or plan during a life event or open enrollment. Each call transmits one change (or a set of related changes) to UHC’s system and updates the enrollment instantly.

    • Benefit: This is the core of real-time benefit administration. Instead of filling out spreadsheets or going through manual portals, the employer’s changes in the partner’s system are automatically reflected at UHC. For instance, if HR marks an employee as terminated in their system, this API can immediately terminate coverage at UHC effective on the right date. It reduces errors (no double entry), dramatically speeds up processing (from days to seconds), and ensures that members experience timely updates (e.g., an ID card can be issued promptly for a new hire, and a termed employee doesn’t continue on the bill next month). Essentially, it keeps UHC’s membership records in lockstep with the external admin system in real time.

  • Customer-Level Change Notifications – (Push Notification, Live) – UHC will push out alerts to partners for major employer-level changes. These “business event” notifications would include events like a new group installation completion, changes to the group’s contract or coverage (plan changes, renewals with new rates), or if a contract is terminated or reinstated. Instead of the partner polling for such info, UHC will notify subscribed partners when these events happen.

    • Benefit: Keeps external administrators automatically in sync with big changes. For example, if a client’s policy renews (with perhaps new plan options or rates) or if the group’s coverage terminates for any reason, the partner is informed without delay. They can then update their system or reach out to the client as needed. This proactive notification helps avoid scenarios where the external system is unaware of a renewal or cancellation, thus preventing discrepancies (like showing a plan as active when it actually termed). It improves trust that nothing important will be missed.

  • Member-Level Change Notifications – (Push Notification, Live) – Similar to the above, but for member-specific events. UHC will send a notification if something changes for an individual member’s coverage behind the scenes. For instance, if a member’s enrollment is added or terminated via a different channel (maybe a call to UHC or another synced system), or if certain member details are updated at UHC’s end, the partner would get an alert about that change.

    • Benefit: Allows two-way data synchronization. Even if the external partner isn’t the one making the change (say an update happened through a UHC customer service correction or a retroactive fix), their system will learn of it and can adjust accordingly. This means the external platform’s roster and data stay accurate over time without manual auditing. It closes the loop so that any change, no matter where initiated, is reflected in both places.

  • Benefit Update Notifications – (Push Notification, In Planning) – UHC will notify partners if plan benefit details change for the products the group has. Sometimes after initial setup, certain plan info might be updated (for example, a benefit enhancement, correction, or a rider added at renewal). This notification will signal that the partner should fetch the latest benefit details again for that group’s plans.

    • Benefit: Ensures that the benefits information displayed on the external platform is always current. If, say, the copay or coverage level was adjusted by UHC effective a certain date, the external system can get that update and show the new values to users. This avoids confusion or misinformation if plan details evolve, especially in cases where updates happen mid-year or at renewal time.

  • Broker Change Notification – (Push Notification, In Planning) – Sends an alert if the Broker of Record for the group changes in UHC’s system. In the insurance business, an employer may switch their broker/agent. If UHC records a new broker as the official representative for the client, this notification lets the partner system know about it.

    • Benefit: Maintains alignment on who has authority and access. For example, if an external benefit admin platform was working with Broker A for a client and now Broker B takes over, that might affect permissions or who receives information. By getting an automatic alert, the partner can update their records (e.g., change which broker’s portal the client is linked to, or ensure the former broker’s access is removed if necessary). It’s an important compliance and relationship management aspect, making sure the data exchange is only happening with the current authorized parties.

In summary, the B2B Data Externalization Program API provides a comprehensive suite of services that modernizes how external partners interact with UHC for small business insurance. The Shopping & Quoting APIs let brokers and comparison platforms fetch plan options, pricing, and required documents on-demand, creating a faster and more accurate quoting experience for new business. The Benefit Administration APIs support the after-sale needs by syncing customer and member data in real time, eliminating manual file exchanges, and ensuring that any change in one system is reflected in the other. Together, these APIs help external users (brokers, benefit admins, and ultimately employers and members) by reducing paperwork, shortening wait times, and improving the accuracy of information – ultimately making it easier to do business with UHC and manage health benefits through external tools. The result is a more seamless end-to-end experience: from getting a quote to installing a new group and administering their benefits, all via robust, easy-to-integrate APIs in a secure and compliant manner.