Choose Your Integration Path

Use this guide to identify the right starting point for your implementation. Lynx supports a range of integration models — from a single employer offering HSA to a TPA managing hundreds of employer groups to a health plan launching a full supplemental benefits suite. The right path depends on three questions:

Do you need to manage client organizations?

What are you looking to build?

Do You Need to Manage Client Organizations?

A Client Org is the container where members are enrolled, products are configured, and cards are issued. The first question is whether Lynx sets up your Client Org(s) during implementation, or whether you create and manage them programmatically.

Single Client Org (Lynx Configures)

You don't need to manage client organizations if you're launching a single program or a unified experience for your members.

Examples:

  • Employer offering HSA + FSA to employees
  • Health plan launching supplemental benefits for all members
  • Digital health platform embedding a benefit product(s)

What happens:

  • Lynx provisions your Client Org during implementation
  • Lynx works with you to set up your product(s), plan(s), card package(s), and configurations
  • You receive API credentials and proceed directly to member enrollment
  • No Business Enrollment API needed

Start with: Enroll a Member

Multi-Tenant (You Manage Client Orgs)

You need to manage client organizations if you're a TPA, benefits administrator, or platform serving multiple distinct entities — each with their own members and potentially their own configurations.

Examples:

  • TPA administering FSA/HRA for 100+ employer groups
  • Benefits platform white-labeling for multiple health plans
  • Payroll provider offering embedded CDH accounts to their clients
  • ICHRA Platform administering for multiple employer groups

What happens:

  • Lynx provisions your parent Client Org during implementation
  • You use the Business Enrollment API to create child Client Orgs
  • Each child org has its own members, accounts, and transactions
  • Child orgs can inherit parent configuration or be customized

The complexity spectrum:

Scenario

ScenarioWhat You're DoingAPI Complexity
Simple multi-tenantCreating child orgs that inherit parent config. Same products, same card package, same program structure. You're creating containers for member segregation.Low — just POST /clientOrg with parent reference
Configurable multi-tenantEach child org has its own product mix, election amounts, or card packages. Employer A gets FSA + LPFSA, Employer B gets FSA only with different elections.Medium — POST /clientOrg with product and configuration variations
Complex multi-tenantEach child org has unique purse configurations, APL assignments, or program structures. Different health plans with different OTC catalogs.Higher — requires coordination with Lynx for sub_program and purse setup

Key APIs:

EndpointPurpose
POST /clientOrgCreate a new child Client Org
PATCH /clientOrgUpdate a Client Org, add products
GET /clientOrg/{name}/plan/summaryRetrieve available plans and card packages
GET /clientOrg/{name}Retrieve Client Org details and status

Start with: Client Org Management → then Enroll a Member

What Are You Looking to Build?

Lynx is unique, and not tied down to defined product structures. Lynx offers out of the box products, but also supports the ability to configre an account/card to how you see fit

If you are building...Start here
HSA or member-owned accountConsumer-Owned Accounts Quick Start
Prepaid, HRA, FSA, Commuter, ICHRA, or other Employer/Health Plan-sponsored benefitPlan-Owned Programs Quick Start
Healthy food, OTC, rewards, or restricted spend programFiltered Spend / Restricted Wallet Quick Start
Storefront, cart, checkout, or order-management experienceE-Commerce / Commerce-First Quick Start

Note: These aren't mutually exclusive. Many implementations combine multiple paths:

  • TPA offering HSA + FSA: Consumer-Owned (for HSA) + Plan-Owned (for FSA)
  • Health plan with OTC storefront: Filtered Spend + E-Commerce
  • Medicare Advantage full suite: Plan-Owned + Filtered Spend + E-Commerce