Search-Only Integration Flow

The Search-Only flow allows partners to display plan options to users without collecting personal information or enabling direct checkout. This is ideal for comparison tools, quote engines, and informational displays.

Overview

sequenceDiagram
    participant Partner
    participant ChaizAPI as Chaiz API
    participant User
    participant ChaizSite as Chaiz Website

    Partner->>ChaizAPI: POST /PlansSearchAsync/VIN
(no user details)
    Note over ChaizAPI: Processing search...
    ChaizAPI-->>Partner: Plans with public URLs
    Partner->>User: Display plan options
    User->>Partner: Clicks plan link
    Partner->>ChaizSite: Redirect to planCheckoutUrl
    Note over ChaizSite: User must enter
all information
    User->>ChaizSite: Fill contact & payment info
    ChaizSite-->>User: Order confirmation

When to Use

• Building a comparison or quote tool
• Need to show plan options before collecting user information
• Want to display pricing without direct checkout capabilities
• Creating informational widgets or embeds

Integration Flow

Step 1: Search for Plans

Call one of the search endpoints based on available vehicle data:

• POST /api/v2/Partners/PlansSearchAsync/VIN — Search by VIN
• POST /api/v2/Partners/PlansSearchAsync/MakeModelYear — Search by Make/Model/Year
• POST /api/v2/Partners/PlansSearchAsync/LicensePlate — Search by License Plate

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

Step 2: Poll for Results

These are async endpoints. Poll the same endpoint until you receive a 201 Created status. Poll interval: 1-2 seconds.

• 200 OK or 202 Accepted — Search in progress, poll again in 1-2 seconds
• 201 Created — Results ready
• 400 Bad Request — Check error details

Step 3: Display Plans

The response includes plan options with pricing, coverage details, and ratings. Each plan includes:

• planCheckoutUrl — Link to Chaiz checkout (user must enter all info)
• planSummaryUrl — Link to plan details page
• planContractUrl — PDF contract

When users click a plan link, they'll be directed to Chaiz where they must enter their contact and payment information to complete the purchase.

Next Steps

• Live Flow — End-to-end purchase flow with pre-filled checkout
• Pre-Registered Vehicles — Cache vehicles for near-instant search results
• Error Codes — Handle API errors gracefully