Live Flow Integration

The Live Flow enables partners to search for plans while collecting user information, creating a seamless checkout experience. Users can proceed directly to pre-filled pages without re-entering their details.

Overview

The Live Flow provides two paths to purchase:

Direct to Checkout (Most Common)

sequenceDiagram
    participant Partner
    participant ChaizAPI as Chaiz API
    participant User
    participant Checkout as Chaiz Checkout

    Partner->>ChaizAPI: POST /PlansSearchWithUserInfo/Vin
(with user details)
    ChaizAPI-->>Partner: Plans with checkout URLs
    Partner->>User: Display plan options
    User->>Partner: Selects plan
    Partner->>Checkout: Redirect to planCheckoutUrl
    Note over Checkout: Pre-filled user info
Payment only
    User->>Checkout: Complete payment
    Checkout-->>User: Order confirmation

User lands on payment page with pre-filled contact info and enters payment details to complete purchase.

Via Product Details Page (Optional)

sequenceDiagram
    participant Partner
    participant ChaizAPI as Chaiz API
    participant User
    participant ProductPage as Plan Details Page
    participant Checkout as Chaiz Checkout

    Partner->>ChaizAPI: POST /PlansSearchWithUserInfo/Vin
(with user details)
    ChaizAPI-->>Partner: Plans with summary/checkout URLs
    Partner->>User: Display plan options
    User->>Partner: Selects plan
    Partner->>ProductPage: Redirect to planSummaryUrl
    Note over ProductPage: View coverage details
Duration options
Price breakdown
    User->>ProductPage: Click "Proceed to Checkout"
    ProductPage->>Checkout: Redirect to checkout
    Note over Checkout: Pre-filled user info
Payment only
    User->>Checkout: Complete payment
    Checkout-->>User: Order confirmation

User reviews full coverage breakdown and pricing, then clicks "Proceed to Checkout" to enter payment details.

When to Use

Building an end-to-end purchase flow
Want to streamline checkout with pre-filled user information
Need higher conversion rates with minimal user friction
Creating a white-label or embedded purchase experience

Integration Flow

Step 1: Search with User Information

Call POST /api/v2/Partners/PlansSearchWithUserInfo/Vin with vehicle details (VIN, mileage) and user contact information (name, email, address, phone). The API returns immediately with results — no polling required.

See the API Reference for complete endpoint details, request/response schemas, and code examples.

Step 2: Display Results

The API returns plan options with two URLs for each plan:

planCheckoutUrl — Direct to payment (fastest checkout)
planSummaryUrl — View plan details first (coverage info, then checkout)

Both URLs include encoded user information for pre-filling forms on Chaiz pages.

Step 3: Redirect to Chaiz

When a user selects a plan, redirect them to either URL based on your UX preference.

Your partner configuration may restrict available payment methods, durations, or providers on Chaiz pages.

User Account Handling

When you submit user details with a search, a new account is created automatically for new users, or the existing account is matched by email. The returned URLs include encoded user information, so users don't need to manually create accounts or log in.

Next Steps

Search Only — Display plan options without checkout capabilities
Pre-Registered Vehicles — Cache vehicles for near-instant search results
Error Codes — Handle API errors gracefully

Vehicle Lookup

Search Only