> ## Documentation Index
> Fetch the complete documentation index at: https://docs.api.nkama.ga/llms.txt
> Use this file to discover all available pages before exploring further.

# NKAMA API

> Build on the NKAMA property rental & management platform.

NKAMA is a property rental and management platform for **Gabon**. This is the
documentation for its REST API: how to authenticate, the conventions every
endpoint follows, and a full, always-current [API reference](/api-reference).

<CardGroup cols={2}>
  <Card title="Get started" icon="play" href="/getting-started">
    Make your first authenticated call in a few minutes.
  </Card>

  <Card title="Authentication" icon="key" href="/authentication">
    OpenID Connect via Keycloak — get and use a bearer token.
  </Card>

  <Card title="Owner onboarding" icon="id-card" href="/guides/owner-onboarding">
    How a tenant becomes a verified owner and lists a property.
  </Card>

  <Card title="API reference" icon="code" href="/api-reference">
    Every endpoint and schema, generated from the service.
  </Card>
</CardGroup>

## Conventions

The whole API follows a few rules, so you only learn them once:

* **Base path** — every endpoint lives under `/api/v1`.
* **Auth** — all endpoints require a bearer access token, except sign-up, password
  reset, the public legal-version endpoint, and vendor webhooks. See
  [Authentication](/authentication).
* **Tenancy** — data is isolated per organization via the token's `org_id` claim. A
  caller only ever sees their own organization's resources.
* **Money** — amounts are integers in **XAF minor units** (e.g. `250000` = 2 500 FCFA).
* **Time** — all timestamps are UTC, ISO-8601.
* **Errors** — failures use [RFC 9457 problem+json](https://www.rfc-editor.org/rfc/rfc9457)
  with a stable `type` URN (e.g. `urn:nkama:error:verification-document-expired`).

## Environments

| Environment | API base URL                   | Identity (Keycloak)                 | Status      |
| ----------- | ------------------------------ | ----------------------------------- | ----------- |
| Production  | `https://api.nkama.ga`         | `https://auth.yvnn.is/realms/nkama` | Live        |
| Sandbox     | `https://sandbox.api.nkama.ga` | `https://auth.yvnn.is/realms/nkama` | Coming soon |

This documentation is served at [`docs.api.nkama.ga`](https://docs.api.nkama.ga).

<Note>
  Production is live at `api.nkama.ga`, the identity issuer at `auth.yvnn.is`, and the docs at
  `docs.api.nkama.ga`. The sandbox host is not deployed yet — its base URL above is a placeholder
  until then.
</Note>