Skip to content

Changelog

The changelog highlights notable updates to customer-facing APIs and portals.

2025-02-11 (v1.10.0)

Added

  • FirstCyber Quote APIpolicy_fee field added to quote response
    • POST /quote/firstcyber/submit and GET /quote/firstcyber/status/:id responses now include policy_fee in the policy_term object
    • String value (e.g. "$300.00") representing the policy fee amount
    • Updated OpenAPI spec and documentation

2026-01-29 (v1.9.0)

New Endpoint in the Quote API

  • Get Policy Document
    • Added endpoint: GET /quote/firstcyber/document/policy/stream/:id
      • Get a policy document after a quote is issued.
    • Updated documentation and postman document with new endpoint.

2026-01-20 (v1.8.0)

Breaking Changes

  • GET /quote/firstcyber/status/:id - The quote_status field has new values

    • Status replacements:
      • published → replaced by ready_to_bind and approved_rate
      • pendingBindAndIssue → replaced by bound
    • New status flow: pendingready_to_bindboundissued
    • Additional new statuses: declined, underwriter_review
    • Retained statuses: pending, issued, failed
    • Migration guidance: For minimum changes to maintain the same functionality:
      • Replace published with ready_to_bind in your code
      • Replace pendingBindAndIssue with bound in your code
  • PUT /quote/firstcyber/bind/:id - Response structure has been simplified

    • Now returns a 202 and "accepted" status:
    json
    {
      "status": "accepted",
      "data": {
          "id": "afe35e49-f801-4d4a-963d-0a17a3e4833d"
      }
    }
    • An event will be emitted with the policy ID once bind completes

Added

  • API Downloads Section: Added downloadable OpenAPI specs and Postman collections to documentation
    • FirstCyber Quote Service: OpenAPI spec (YAML) and Postman collection with pre-configured requests
    • PersonalCyber Quote Service: OpenAPI spec (YAML)
    • Download links added to each service documentation page
    • Partner Portal "Getting Help" section updated with direct download links
    • Postman collection includes example requests, auto-token saving, and collection variables

2025-12-12 (v1.7.0)

Added

  • PostHog Analytics Integration: Added production-ready PostHog analytics tracking
    • Client-side analytics initialization with SSR-safe implementation
    • Automatic pageview tracking on initial load and VitePress route navigation
    • Session recording with privacy-first configuration (all text and inputs masked)
    • Autocapture enabled for automatic event tracking
    • Analytics disabled in development by default (can be enabled via VITE_POSTHOG_KEY)
    • Graceful degradation when PostHog key is not configured
    • Environment variables: VITE_POSTHOG_KEY and VITE_POSTHOG_HOST (optional, set at build time)

Why

Enable product analytics to understand documentation usage patterns, track popular pages, and improve the documentation experience. The implementation follows VitePress best practices and ensures analytics do not interfere with SSR or static site generation.


2025-12-11 (v1.6.0)

Changed

  • Partner Portal Documentation: Comprehensive rewrite based on current implementation

    • Clarified credential management workflow (Integration Keys, M2M Clients, Webhook Keys)
    • Important clarification: Webhook Keys are registration tokens for Webhook Portal access only—they are NOT signing secrets
    • Updated authentication flow examples with correct endpoints
    • Added detailed explanations for each credential type and its purpose
    • Improved troubleshooting section with common issues
  • Webhook Portal Documentation: Major update to reflect actual implementation

    • Documented two access methods: Partner Admin Login (recommended) and Webhook Key Registration
    • Important clarification: Signing secrets for webhook verification are generated per-endpoint, not from Partner Portal webhook keys
    • BREAKING: Corrected webhook header names:
      • Event-ID (not X-K2-Event-Id)
      • Timestamp (not X-K2-Delivery-Timestamp)
      • X-Platform-Signature (not X-K2-Signature)
    • BREAKING: Corrected signature verification: Signature is computed over ${Event-ID}.${Timestamp}.${RequestBody}, not just the body
    • Corrected timeout: 8 seconds (not 30 seconds)
    • Corrected retry logic: Exponential backoff (1s, 2s, 4s... up to 60s), max 10 attempts
    • Added circuit breaker documentation: Endpoints disabled after 5 failures in 5 minutes
    • Updated event types to accurately reflect the 3 currently available events
    • Added complete code examples for Node.js and Python signature verification
    • Added idempotency implementation example
  • Quick Start Guide: Added Partner Portal URLs to environment table


2025-12-11

  • BREAKING CHANGE: An Integration key in the x-integration-key header is now REQUIRED when using endpoints within the quote service.
  • Updated quick start and partner portal documentation to reflect current implementation around credential management and usage.

2025-12-08

  • Sandbox Environment Now Available: The sandbox environment is now live for integration development and testing
    • API Sandbox: https://api-sandbox.k2cyber.co
    • Partner Portal Sandbox: https://partners-sandbox.k2cyber.co
    • Webhook Portal Sandbox: https://webhook-portal-sandbox.k2cyber.co
    • Isolated synthetic data for safe testing
    • Updated documentation across Quick Start, FirstCyber Quote Service, Personal Cyber Quote Service, Partner Portal, and Webhook Portal
    • OpenAPI specs now default to sandbox URLs for "Try it out" functionality

2025-20-17

  • POST /quote/firstcyber/submit: taxid is no longer required to create a quote.

2025-11-17

  • Added GET /document/quote-preview/:id endpoint to firstcyber-quote.yaml and corresponding .md

2025-11-06

  • Added M2M (Machine-to-Machine) Client documentation to Partner Portal
    • New authentication method using Stytch for API access
    • Includes setup instructions, usage examples, and comparison with Integration Keys
    • M2M clients automatically provisioned with quote scope
    • Support for activate/deactivate operations

2025-10-23

  • Temporarily disabled Personal Cyber Quote Service documentation from navigation (content preserved for future re-enablement)

2025-10-22

  • Corrected Partner Portal URL

2025-10-21

  • Updated Personal Cyber Quote Service documentation to match FirstCyber format
  • Removed test environment URL (api-test.k2cyber.co) in favor of "Sandbox Environment - Coming Soon" message
  • Consistent messaging across all quote service documentation

2025-02-15

  • Added admin quote endpoint documentation and sample payloads.
  • Improved webhook portal insight panels with retry counts.

2025-01-12

  • Partner Portal added integration key rotation workflow and deployment-ready Dockerfile.

2024-12-03

  • Initial publication of the customer documentation portal.

Maintained by the K2 Cyber Insurance engineering team.