Skip to main content

Onboarding API Overview

1. Purpose​

  • The Onboarding API helps approved partners connect their benefits or membership systems with the host organization’s systems.
  • It allows partners to initiate group registrations or updates, enabling seamless integration and status tracking.
  • The service ensures that submitted group data is validated and securely transitioned into the host system, supporting efficient onboarding and data integrity.

2. Who can use this service​

  • Approved partners such as brokers, benefit administrators, and aggregators who have a formal relationship with the host organization.
  • Authorized users within those organizations, including:
    • Business analysts
    • Contract administrators
    • Relationship managers
  • Access is granted through a structured onboarding process, ensuring secure and appropriate use.

3. What information is available​

The service provides high-level insights into:

  • Group registration status – Whether a group has been successfully onboarded or is awaiting final steps.
  • Summary details – Broad indicators of coverage, eligibility, and group characteristics.
  • Integration status – Flags or timestamps that show the progress of onboarding and any pending actions.
  • The focus is on what’s happening with the group, not on technical formats or field-level data.

4. Benefits of this service​

  • Real-time updates – Group data is synchronized instantly between systems, reducing delays and manual effort.
  • Simplified experience – Partners receive clear summaries instead of complex technical payloads.
  • Efficient engagement – A defined onboarding path ensures smooth integration and predictable outcomes.
  • Scalable and adaptable – The service can evolve to include new summary categories without disrupting existing users.

5. Example uses​

  • A broker registers a new employer group and quickly confirms its onboarding status before updating the client.
  • An administrator updates group details due to a broker change and verifies the changes in real time.
  • A portfolio analyst reviews onboarding status across multiple groups to identify pending actions.
  • A relationship manager prepares for a meeting by checking that all group transitions are complete and healthy.

6. Important notes​

  • This overview is intended for a general audience. Technical details such as authentication steps, API calls, endpoint URLs, and error codes are not included here.
  • Access is restricted to approved partners who have completed the onboarding process.
  • The service may evolve over time. Partners should consult their relationship manager for updates or to request additional summary categories.
  • Use of the service implies agreement with confidentiality and intellectual property protections outlined in the partner program.