v2.0.0
OpenAPI 3.1.1
Chaiz Partner API
Search, compare, and sell vehicle service contracts (VSCs, also called extended warranties) from a network of warranty administrators. Returns real-time quotes with pricing, coverage detail, provider ratings, and ready-to-use checkout links.
New here? This reference documents every endpoint. To work out which ones you need, read Choose Your Integration first: there are two integration paths and it takes one page to pick yours.
- Quickstart gets you a live quote and a working checkout link in about ten minutes.
- Plan Search Reference covers vehicle identification, filters, and response shapes.
- UI Requirements lists what your results page must show.
- Going Live covers onboarding, sign-off, and the switch to production.
- Errors and Rate Limits covers the error envelope and retry behavior.
Things to know before you start
- Authentication: every endpoint except registration needs
Authorization: Bearer <your-key>. Your partner identity is inside the token, so leave the optionalpartnerfield out of request bodies. - Latency: synchronous plan searches take 2 to 8 seconds because Chaiz is collecting live rates from multiple administrators. Use a timeout of at least 30 seconds and never retry a slow search; a retry quotes the vehicle twice.
- Response envelope: Partner API responses are wrapped as
{ response, errorResponse }, except the registration endpoints (/api/v2/Partners/Register*): their success bodies are plain objects, and Register and Verify answer 400 as one plain-text sentence. In a wrapped response, checkerrorResponsebefore readingresponse. - Result freshness: a search result is a quote for that moment. Search again when it is older than 30 days or the mileage changes.
- Environments: keys are issued per environment and are not interchangeable.
- Discovery:
/.well-known/chaiz-api.jsonis the machine-readable API manifest.
Client Libraries