Pre-Registered Flow Integration

The Pre-Registered Flow allows partners to cache vehicle data ahead of time, enabling near-instant plan search results when users are ready to view options. This is ideal for high-traffic platforms where response time is critical.

Overview

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

    Note over Partner,Cache: Phase 1: Pre-Registration
    Partner->>ChaizAPI: POST /VehicleRegistration
(VIN + mileage)
    ChaizAPI->>Cache: Cache vehicle plans
(30-day expiry)
    Cache-->>ChaizAPI: Cached successfully
    ChaizAPI-->>Partner: Registration complete

    Note over Partner,User: Phase 2: User Search (Later)
    User->>Partner: Request plan options
    Partner->>ChaizAPI: POST /PlansSearchAsync/VIN
    ChaizAPI->>Cache: Check cached data
    Cache-->>ChaizAPI: Return cached plans
    ChaizAPI-->>Partner: Instant results (201 Created)
    Partner-->>User: Display plans immediately

When to Use

• High-traffic websites with known vehicle inventory
• Dealer management systems with vehicle lists
• Platforms where users browse before viewing plan options
• Any scenario where you can anticipate vehicle lookups

How It Works

Pre-registered vehicle data is cached for 30 days using VIN + mileage as the cache key. If mileage changes by 5,000+ miles, re-register for accurate pricing.

• Cached results are available for all states and durations

Integration Flow

Step 1: Pre-Register Vehicles

Call POST /api/v2/Partners/VehicleRegistration with VIN and mileage when vehicles enter your system (e.g., inventory import, user saves vehicle).

This is an async endpoint — poll until you receive 201 Created:

• 200 OK or 202 Accepted — Registration in progress, poll again in 1-2 seconds
• 201 Created — Vehicle cached successfully
• 400 Bad Request — Check error details

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

Step 2: Search for Cached Vehicles

When users request plan options, you have two options:

Call POST /api/v2/Partners/PlansSearchAsync/VIN to get complete plan information. For cached vehicles, the first request returns 201 Created immediately with full results — no polling needed.

Call POST /api/v2/Partners/PlansSearchAsync/GetStartPrice to get just the starting price. This is faster and useful for displaying quick price estimates.

Step 3: Clear Cache (Optional)

Use POST /api/v2/Partners/VehicleRegistration/CleanVehicleCache if vehicle data changes or you need fresh results.

Best Practices

When to Register

Scenario	Timing
Dealer inventory	When vehicles are added to inventory
User-saved vehicles	When user saves a vehicle to their profile
Lead capture	After collecting vehicle information
Scheduled refresh	Daily/weekly for high-priority vehicles

Cache Management

1. Re-register on mileage changes: If a vehicle's mileage changes by more than 5,000 miles, re-register for accurate pricing
2. Clear cache on data issues: If a user reports incorrect information, clear the cache
3. Monitor registration failures: Track failed registrations and retry during off-peak hours

Performance Tips

• Register vehicles during off-peak hours when possible
• Use batch registration with controlled concurrency (5-10 concurrent requests)
• Implement exponential backoff for retries
• Cache registration status locally to avoid duplicate requests

Important Note

Pre-registration is required — vehicles must be registered via /api/v2/Partners/VehicleRegistration before you can get instant search results. Searching for an unregistered vehicle requires registration first.

Next Steps

• Live Flow — End-to-end purchase flow with pre-filled checkout
• Search Only — Display plan options without checkout capabilities
• Error Codes — Handle API errors gracefully