# Rikor Client API

Version: `1.0.0`

Read compliance status, scores and the per-coverage ledger for the franchisees in your scope. Authenticate with `Authorization: Bearer rikor_sk_…`. Every list is cursor-paged; every response carries `as_of`. Enums are open: treat an unknown value as `unknown`.

## Servers

- `https://api.rikor.io`

## Endpoints

### Identity

Who a key is, the brands it reaches right now and its rate limit.

- [`GET /v1/me`](/api/me#get-v1me): Retrieve the current key

### Franchisors

Brands in your scope: requirements, compliance rollups and the daily trend.

- [`GET /v1/franchisors`](/api/franchisors#get-v1franchisors): List franchisors
- [`GET /v1/franchisors/{id}`](/api/franchisors#get-v1franchisorsid): Retrieve a franchisor
- [`GET /v1/franchisors/{id}/requirements`](/api/franchisors#get-v1franchisorsidrequirements): Retrieve requirements
- [`GET /v1/franchisors/{id}/compliance-summary`](/api/franchisors#get-v1franchisorsidcompliance-summary): Retrieve compliance summary
- [`GET /v1/franchisors/{id}/compliance-trend`](/api/franchisors#get-v1franchisorsidcompliance-trend): Retrieve compliance trend
- [`PUT /v1/franchisors/{id}/external-id`](/api/franchisors#put-v1franchisorsidexternal-id): Set a franchisor external id
- [`DELETE /v1/franchisors/{id}/external-id`](/api/franchisors#delete-v1franchisorsidexternal-id): Clear a franchisor external id
- [`GET /v1/compliance-summary`](/api/franchisors#get-v1compliance-summary): Retrieve scope summary

### Franchisees

Locations in your scope, their compliance status and the per-coverage ledger.

- [`GET /v1/franchisees`](/api/franchisees#get-v1franchisees): List franchisees
- [`GET /v1/franchisees/{id}`](/api/franchisees#get-v1franchiseesid): Retrieve a franchisee
- [`PUT /v1/franchisees/{id}/external-id`](/api/franchisees#put-v1franchiseesidexternal-id): Set a franchisee external id
- [`DELETE /v1/franchisees/{id}/external-id`](/api/franchisees#delete-v1franchiseesidexternal-id): Clear a franchisee external id
- [`POST /v1/external-ids`](/api/franchisees#post-v1external-ids): Set external ids in bulk

### Connections

Partner keys: the brands that authorized you, and their status.

- [`GET /v1/connections`](/api/connections#get-v1connections): List connections