# Wathiqaty Insurer API

> System-to-system REST API for insurance companies selling through Wathiqaty (وثيقتي), an Egyptian insurance marketplace: receive issued policies, decide cancellations, work claims, sync pricing, reconcile commission. OAuth 2.0 client credentials, JSON envelope, signed webhooks. Status: v1 draft, not yet live.

Every page is available as Markdown by adding `.md` to its URL. `llms-full.txt` has all of them in one file; `openapi.json` is the machine-readable spec.

## Guides

- [Introduction](https://developers.wathiqaty.com/guides/introduction.md): What the Insurer API does, how a sale reaches your systems, environments and prerequisites.
- [Quickstart](https://developers.wathiqaty.com/guides/quickstart.md): From sandbox credentials to a policy booked in your system in five calls.
- [Authentication](https://developers.wathiqaty.com/guides/authentication.md): API clients, scopes, OAuth 2.0 client-credentials tokens and caching them.
- [Going live](https://developers.wathiqaty.com/guides/go-live.md): Onboarding steps, the go-live checklist and support.
- [Conventions](https://developers.wathiqaty.com/guides/conventions.md): Envelope, data formats, money, pagination, change feed, idempotency, If-Match, files, personal data.
- [Errors](https://developers.wathiqaty.com/guides/errors.md): Every generic error code, what it means and when to retry.
- [Rate limits](https://developers.wathiqaty.com/guides/rate-limits.md): Limits per client and company, rate-limit headers and backing off.
- [Webhooks](https://developers.wathiqaty.com/guides/webhooks.md): Event types with example bodies, signature verification, retries and endpoint requirements.
- [Sandbox](https://developers.wathiqaty.com/guides/sandbox.md): Sandbox data, weekly reset, the customer simulator and rehearsal scenarios.
- [Versioning & changelog](https://developers.wathiqaty.com/guides/versioning.md): Versioning policy, deprecation and the changelog.

## API reference

- [Authentication](https://developers.wathiqaty.com/reference/authentication.md): 1 endpoint. Exchange your API client's credentials for a 15-minute bearer token (OAuth 2.0 client credentials, RFC 6749 §4.4).
- [Company](https://developers.wathiqaty.com/reference/company.md): 1 endpoint. Your company as Wathiqaty sees it.
- [Packages](https://developers.wathiqaty.com/reference/packages.md): 7 endpoints. Packages (your products) are authored by your staff in the Wathiqaty portal, because benefits, wordings and documents need a human.
- [Policies](https://developers.wathiqaty.com/reference/policies.md): 5 endpoints. Wathiqaty issues a policy the moment the customer's payment is captured, and sends `policy.issued`.
- [Cancellations](https://developers.wathiqaty.com/reference/cancellations.md): 5 endpoints. A customer's cancellation request waits for your decision (`cancellation.requested`).
- [Claims](https://developers.wathiqaty.com/reference/claims.md): 13 endpoints. The full claim workflow: `submitted` → `under_review` ⇄ `documents_requested` → `approved` → `settled` → `closed`, or `rejected` → `closed`.
- [Finance & settlements](https://developers.wathiqaty.com/reference/finance.md): 7 endpoints. Every captured payment freezes its breakdown: gross (tax-inclusive) = net + taxes, and Wathiqaty's commission is a share of the net.
- [Bordereaux](https://developers.wathiqaty.com/reference/bordereaux.md): 2 endpoints. CSV files for reconciliation, or for companies that integrate by file first.
- [Webhook endpoints](https://developers.wathiqaty.com/reference/webhook-endpoints.md): 8 endpoints. Where Wathiqaty sends events (see the Webhooks guide for payloads and signatures).
- [Sandbox simulator](https://developers.wathiqaty.com/reference/sandbox.md): 5 endpoints. Sandbox-only routes that play the customer, so you can drive every flow from your side without the Wathiqaty app.

## Optional

- [OpenAPI 3.1 spec](https://developers.wathiqaty.com/openapi.json): every endpoint, parameter, body and example
- [Full documentation](https://developers.wathiqaty.com/llms-full.txt): all pages in one Markdown file