Get Started

Quickstart

By the end of this page you will have a real API key, a live quote, and a working checkout link. Roughly ten minutes. Everything here runs against UAT, so nothing you do is a real sale.

Base URL for this page: https://chaiz-api-uat.azurewebsites.net. Swap in https://api.chaiz.com when you go live. Keys are per environment and are not interchangeable.

1. Register for a key

Self-service registration is the fastest way to start experimenting, and that is what this page uses. It gives you a key against Chaiz defaults.

For anything you intend to launch, go through managed onboarding instead: your own branding at checkout, the providers and payment terms you actually want to sell, higher rate limits, and attribution configured so sales are credited to you. Email dev-support@chaiz.com. The integration code is identical, so nothing you build here is wasted. See Authentication.

Registration is two calls. The first sends a verification code to your email; the second exchanges that code for your API key. 

curl -X POST https://chaiz-api-uat.azurewebsites.net/api/v2/Partners/Register \
  -H "Content-Type: application/json" \
  -d '{
    "contactEmail": "you@example.com",
    "displayName": "Example Integration",
    "agreedToTerms": true
  }'

Check that inbox, then verify. The response to this call contains your API key, and it is the only time it is shown. Store it now. 

curl -X POST https://chaiz-api-uat.azurewebsites.net/api/v2/Partners/Register/Verify \
  -H "Content-Type: application/json" \
  -d '{
    "email": "you@example.com",
    "code": "123456"
  }'

Self-registered keys start on the free tier (50 requests per hour). That is plenty for building, and you can move to a higher tier before launch. See Errors & Rate Limits for the full table, or Authentication for enterprise credentials, rotation, and storage requirements.

2. Run your first search

Every request from here needs Authorization: Bearer <your-key>.

This example searches by make, model, and year, which needs no specific vehicle to exist. In production, prefer VIN: it is more accurate and it saves your customer from typing a VIN later. 

curl -X POST https://chaiz-api-uat.azurewebsites.net/api/v2/Partners/PlansSearch \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "searchCriteria": {
      "make": "HONDA",
      "model": "ACCORD",
      "year": 2019,
      "mileage": 55000,
      "stateShortName": "TX"
    }
  }'

This call takes 2 to 8 seconds. It is not slow code; Chaiz is collecting live rates from multiple warranty administrators while you wait. Set your HTTP client timeout to at least 30 seconds and do not retry on a slow response, or you will quote the same vehicle twice.

Make and model must match our catalog values. If you are working from free text a customer typed, resolve it first with GET /api/v2/Partners/Vehicles/Lookup. See Plan Search Reference.

3. Read the result

The response wraps a list of plans. Two fields matter most:

{
  "response": {
    "searchId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    "results": [
      {
        "searchResultPlanId": 12345,
        "planName": "Platinum Coverage",
        "displayProviderName": "CAPS Protection Plan",
        "duration": 36,
        "totalPrice": 1899.99,
        "downpayment": 199.99,
        "monthlyPrice": 141.67,
        "deductible": 100,
        "planChaizRating": 9.2,
        "planSummaryUrl": "https://chaiz.com/product-details?searchResultPlanId=12345&fp=1",
        "planCheckoutUrl": "https://chaiz.com/checkout?searchResultPlanId=12345&fp=1"
      }
    ]
  },
  "errorResponse": null
}

Every response is wrapped this way: response holds the payload, errorResponse holds problems, and exactly one of them is populated. See Errors & Rate Limits.

Field Why you care
searchResultPlanId Identifies this exact plan at this exact price. You need it to create an order, and it is embedded in the handoff URLs.
planCheckoutUrl Send your customer here and Chaiz takes it from there: payment, contract, confirmation email.
planSummaryUrl Send them here instead if you want them to read the coverage detail first.

Prices are per plan and already reflect the vehicle, mileage, state, and anything your account restricts. Do not recompute them.

Results are valid for 30 days. After that the searchResultPlanId no longer works and you need a fresh search.

4. Hand off to checkout

Open a planCheckoutUrl from your response in a browser. You will land on a Chaiz checkout with the plan and price already selected. Complete it and you have run the whole flow end to end.

That is the Search & Hand Off integration, and it is what most partners ship. You never received a card number, so you stay out of PCI scope entirely.

Where to go next

You have the mechanics. Now make the one real decision:

  • Choose Your Integration compares the three paths in one table. Read this before building anything beyond a prototype.
  • Search & Hand Off is the full guide to what you just did, including how to keep attribution credit for the sale.
  • Plan Search Reference covers filters, the other vehicle identifiers, and how to make searches faster.
Previous
Introduction
Next
Authentication