Getting Started

Chaiz Partner API Documentation

When you use the Chaiz API, you're agreeing to our API License and Acceptable Use Policy. These terms are non-negotiable and the API is provided as-is without modifications. If you have feedback, feature requests, or specific needs, please contact your account manager or reach out to dev-support@chaiz.com.

Welcome to the Chaiz Partner API. This API enables partners to integrate vehicle service contract (VSC) plan search, quoting, and purchasing capabilities into their platforms.

Overview

The Chaiz Partner API v2 provides a comprehensive set of endpoints for:

  • Registration - Self-service API key registration for instant access
  • Vehicle Lookup - Resolve fuzzy vehicle inputs (make, model, year) into exact identifiers
  • Plan Search - Search for available plans by VIN, Make/Model/Year, or License Plate
  • Async Search & Vehicle Registration - Pre-register vehicles and use async search with polling for cached results
  • Leads - Submit customer leads for follow-up processing
  • Orders - Create and manage plan orders

Base URL

Environment Base URL
Production https://chaiz-api.azurewebsites.net/
UAT https://chaiz-api-uat.azurewebsites.net/

Quick Start

1. Get Your API Credentials

Self-service: Use POST /api/v2/Partners/Register to register with your email and get instant API access. See the Authentication Guide for the full registration flow.

Enterprise: Contact your Chaiz partner manager for dedicated credentials with higher rate limits.

Store your credentials securely using environment variables or a secrets management system.

2. Authenticate Your Requests

All API requests require your Bearer token in the Authorization header. See the Authentication Guide for details on how to authenticate.

3. Choose Your Integration Flow

Pick the integration pattern that fits your use case, then follow the step-by-step guide.

Integration Flows

Flow Description Best For
Live Flow End-to-end purchase with pre-filled checkout Highest conversion rates
Search Only Display plan options without collecting user info Comparison tools, quote engines
Pre-Registered Cache vehicles for near-instant results High-traffic platforms
Leads Submit leads for follow-up processing Lead generation campaigns

Support

For technical support or questions about your integration:

Next Steps

Next
Authentication