# Introduction

Rikor runs insurance compliance for franchise systems. We collect each location's certificates of insurance, read
them, grade every policy against the brand's requirements, and chase what's missing. The **client API** gives your
systems read access to the result\: where every franchisee stands, coverage by coverage, and how the brand is
trending.

```bash
curl https://api.rikor.io/v1/franchisees?limit=25 \
  -H "Authorization: Bearer $RIKOR_KEY"
```

## What you can do

* **Read a location's standing.** Compliance status, a 0–100 score, the policy status, and the next date a policy
  expires.
* **Read the per-coverage ledger.** For each required coverage\: policy number, effective and expiration dates, every
  limit beside the brand's minimum, exemptions, and the open issues in plain words.
* **Roll it up.** Counts by status, compliance percent, average score and per-coverage health for a brand, or one row
  per brand across your whole scope, plus a daily trend.
* **Read the rules.** A brand's published requirement set\: which coverages are required, minimum limits, required
  endorsements and carrier rules.
* **Map your own ids.** Store your location and brand ids on our records, then filter by them.

## Who gets a key

| Key owner | Reaches | Typical use |
| --- | --- | --- |
| **Franchisor** (a brand) | Its own franchisees | A brand's CRM, intranet or BI pulls each location's standing |
| **Platform** (a group of brands) | Every brand under it, kept current as brands join | Portfolio rollups across brands |
| **Partner** (a software vendor) | Only brands that authorized it, one connection per brand | A franchise-software product shows compliance inside its own app |

Same endpoints, same objects, same guarantees for all three. Read [Key owners and scope](/concepts/scope) for the
details.

## The shape of the API

* **Base URL\:** `https://api.rikor.io/v1`
* **Auth\:** `Authorization: Bearer rikor_sk_…` on every request ([Authentication](/authentication))
* **Format\:** JSON, snake\_case keys and enum values, ISO-8601 dates
* **Lists\:** cursor-paged, `limit` up to 100 ([Pagination](/conventions/pagination))
* **Freshness\:** every response carries `as_of`, the time the data was built from
* **Spec\:** OpenAPI 3.1 at [`https://api.rikor.io/v1/openapi.json`](https\://api.rikor.io/v1/openapi.json)

[Quickstart](/quickstart)\: Your first three calls, end to end.

[API reference](/api)\: Every endpoint, parameter and response, generated from the spec.