This page is a concise checklist of what your backend must do to support the Embed SDK. For step-by-step guidance, jump into the linked deep-dives below.

Want to jump straight into the API reference?

Check out our API reference.

Authentication & idempotency (quick reference)

Authenticate with API keys and include idempotency keys on POST requests.

• Guide: Authentication & Idempotency
• API docs: Authentication · Idempotent requests

What your server must do

• Create employers and employees early, then store employer_id and employee_id received from Kota.
• Issue short‑lived Embed Session tokens and return them to your frontend for correctly authenticating with Embed.
• Receive and process webhooks, especially action‑required events.
• Support offboarding flows (with additional safeguards for employees).

Create employers and employees

Create employers first, then employees referencing the employer_id. Send these records as soon as they’re available to avoid delays while Kota completes regulatory checks.

• Detailed guide: Managing employers and employees
• API references: Employer APIs · Employee APIs

Support offboarding

Employer offboarding removes Embedded UI access but does not cancel employees’ policies automatically. Employee offboarding will cancel policies and must be handled with care.

• Safeguard: If triggered in error and before the effective date, you can cancel employee offboarding.

Issue an Embed Session token

Embed sessions provide secure, time-limited access to Kota’s UI components:

• Employer sessions - Allow employers to set up benefits and view group policy details
• Employee sessions - Allow employees to enroll in benefits, manage dependants, and view policy details

Each session token:

• Expires after a set time (included in the API response)
• Can only be used for one employer or employee
• Should be generated fresh each time a user accesses Kota functionality

Generate Tokens

Use the Embed Session API to create tokens. Once generated, pass the token to your frontend to initialize the SDK.

Learn more about frontend implementation

Generate an employer token:

1
curl -X POST https://test.api.kota.io/embed/sessions \
2
  -H "Authorization: Bearer <YOUR_API_SECRET_KEY>" \
3
  -H "Idempotency-Key: 4fe9c195-56db-4cc2-85d3-5512cf558d60" \
4
  -H "Content-Type: application/json" \
5
  -d '{
6
    "employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a"
7
  }'

An example employee token request:

1
curl -X POST https://test.api.kota.io/embed/sessions \
2
  -H "Authorization: Bearer <YOUR_API_SECRET_KEY>" \
3
  -H "Idempotency-Key: 4fe9c195-56db-4cc2-85d3-5512cf558d60" \
4
  -H "Content-Type: application/json" \
5
  -d '{
6
    "employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a"
7
    "employee_id": "ee_2c11435d87d5d4a46ad83ba7f6b0e91b"
8
  }'

Handle webhooks and required actions

Configure a webhook receiver to process asynchronous events.

• Deep‑dive: Webhooks and events
• API overview: Events & Webhooks
• Examples: Working with webhooks

Advanced: Contribution reporting

Retrieve employer/period reports for accurate payroll, including employer vs employee portions, adjustments, and pro‑rations.

• Guide: Contribution reporting
• API: Contribution Reports

Prefer to browse the API directly?

Open the API Reference