Benbase

API Integration

Your payroll engine is not yet supported. You push census data to Benbase via API.

API Integration

Your payroll engine is not yet supported by Benbase, so you provide employee census data via API. Two ways to integrate, depending on your use case:

  • Marketplace quoting only — embed the Employer Flow and pass the census inline for your clients to view quotes.
  • Full integration — also connect webhooks to sync census and report payroll deductions, and embed the Employee Flow for enrollment.
StepUse caseWhat You Do
1. Embed Employer FlowBothEmbed the employer iframe; pass a census inline for quoting
2. Connect APIFull integrationSet up webhooks and respond to census requests
3. Sync DataFull integrationReceive deduction webhooks and report employment changes
4. Embed Employee FlowFull integrationEmbed the employee iframe for benefits enrollment

Prerequisites

  • Benbase API key — prefixed sandbox_sk_ (sandbox) or live_sk_ (production). See Authentication.
  • Webhook endpoint — for the full integration; set up in the Connect API step

→ Start with Embed Employer Flow

3. Embed Employee Flow

Embed the Employee Flow iframe in your platform.

1. Embed Employer Flow

Embed the Employer Flow iframe in your platform.

On this page

API IntegrationPrerequisites