Skip to main content
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.

Get started

Make your first authenticated call in a few minutes.

Authentication

OpenID Connect via Keycloak — get and use a bearer token.

Owner onboarding

How a tenant becomes a verified owner and lists a property.

API reference

Every endpoint and schema, generated from the service.

​
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.
  • 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 with a stable type URN (e.g. urn:nkama:error:verification-document-expired).

​
Environments

EnvironmentAPI base URLIdentity (Keycloak)
Sandboxhttps://sandbox.api.nkama.gahttps://auth.yvnn.is/realms/nkama
Productionhttps://api.nkama.gahttps://auth.yvnn.is/realms/nkama
Confirm the sandbox/production base URLs against your deployment — they are placeholders until the API hosts are finalised. The identity issuer is live at auth.yvnn.is.