# NKAMA

> API documentation for the NKAMA property rental & management platform (Gabon).

## Docs

- [Complete password reset](https://docs.api.nkama.ga/api-reference/account-recovery/complete-password-reset.md): Verifies the code and sets the new password (204). 410/422 when the session is unknown/expired, 429 once the attempt budget is spent.
- [Request a password-reset code](https://docs.api.nkama.ga/api-reference/account-recovery/request-a-password-reset-code.md): Sends a reset code to the number if it has an account; returns the same shape regardless (no account enumeration). Subject to the same rate, allowlist and per-IP guards as sign-up.
- [Complete phone change](https://docs.api.nkama.ga/api-reference/account/complete-phone-change.md): Verifies the code (bound to the new number) and moves the account onto it — it becomes the verified number and the login username (204). The current access token stays valid; the new number takes effect at next login.
- [Request a phone-change code](https://docs.api.nkama.ga/api-reference/account/request-a-phone-change-code.md): Sends a code to the new number for the signed-in user. 422 if it is already the user's number, 409 if another account uses it.
- [Get apiv1bookings](https://docs.api.nkama.ga/api-reference/booking-controller/get-apiv1bookings.md)
- [Get apiv1bookings 1](https://docs.api.nkama.ga/api-reference/booking-controller/get-apiv1bookings-1.md)
- [Post apiv1bookings](https://docs.api.nkama.ga/api-reference/booking-controller/post-apiv1bookings.md)
- [Post apiv1bookings activate](https://docs.api.nkama.ga/api-reference/booking-controller/post-apiv1bookings-activate.md)
- [Post apiv1bookings cancel](https://docs.api.nkama.ga/api-reference/booking-controller/post-apiv1bookings-cancel.md)
- [Post apiv1bookings extend](https://docs.api.nkama.ga/api-reference/booking-controller/post-apiv1bookings-extend.md)
- [Post apiv1bookings submit](https://docs.api.nkama.ga/api-reference/booking-controller/post-apiv1bookings-submit.md)
- [Post apiv1bookings terminate](https://docs.api.nkama.ga/api-reference/booking-controller/post-apiv1bookings-terminate.md)
- [Get a document](https://docs.api.nkama.ga/api-reference/documents/get-a-document.md): Returns a single document's metadata by id.
- [Get a download URL](https://docs.api.nkama.ga/api-reference/documents/get-a-download-url.md): Returns a short-lived presigned URL the client uses to download the rendered PDF directly from object storage.
- [List documents](https://docs.api.nkama.ga/api-reference/documents/list-documents.md): Returns the calling organization's documents, newest first. Pass `subjectId` to restrict the list to a single booking or invoice.
- [Request a signing code](https://docs.api.nkama.ga/api-reference/documents/request-a-signing-code.md): Issues a one-time code to the caller's on-file number, authorizing them to sign this document. The number is taken from the caller's profile, not the request. The returned challenge id and the delivered code are presented back to the sign endpoint to finalize the signature.
- [Sign a document](https://docs.api.nkama.ga/api-reference/documents/sign-a-document.md): Records a signature in the given capacity once the one-time code from the sign/otp step verifies. Signing an already-signed document is idempotent; voided documents cannot be signed.
- [Get apiv1invoices](https://docs.api.nkama.ga/api-reference/invoice-controller/get-apiv1invoices.md)
- [Get apiv1invoices 1](https://docs.api.nkama.ga/api-reference/invoice-controller/get-apiv1invoices-1.md)
- [Post apiv1invoices pay](https://docs.api.nkama.ga/api-reference/invoice-controller/post-apiv1invoices-pay.md)
- [Get apiv1verificationkyc](https://docs.api.nkama.ga/api-reference/kyc-controller/get-apiv1verificationkyc.md)
- [Get apiv1verificationkycmine](https://docs.api.nkama.ga/api-reference/kyc-controller/get-apiv1verificationkycmine.md)
- [Post apiv1verificationkyc](https://docs.api.nkama.ga/api-reference/kyc-controller/post-apiv1verificationkyc.md)
- [Post apiv1verificationkyc documents](https://docs.api.nkama.ga/api-reference/kyc-controller/post-apiv1verificationkyc-documents.md)
- [Post apiv1verificationkyc submit](https://docs.api.nkama.ga/api-reference/kyc-controller/post-apiv1verificationkyc-submit.md)
- [Current legal-document versions](https://docs.api.nkama.ga/api-reference/legal/current-legal-document-versions.md): The Terms of Service and Privacy Policy versions a new account must accept.
- [Get apiv1me](https://docs.api.nkama.ga/api-reference/me-controller/get-apiv1me.md)
- [Delete apiv1media](https://docs.api.nkama.ga/api-reference/media-controller/delete-apiv1media.md)
- [Get apiv1media](https://docs.api.nkama.ga/api-reference/media-controller/get-apiv1media.md)
- [Get apiv1media download url](https://docs.api.nkama.ga/api-reference/media-controller/get-apiv1media-download-url.md)
- [Post apiv1media](https://docs.api.nkama.ga/api-reference/media-controller/post-apiv1media.md)
- [Post apiv1media complete](https://docs.api.nkama.ga/api-reference/media-controller/post-apiv1media-complete.md)
- [Send a verification code to my number](https://docs.api.nkama.ga/api-reference/phone-verification/send-a-verification-code-to-my-number.md): Issues a code to the number on file for the authenticated caller. 422 when no number is on file, 429 when rate-limited, 502 on delivery failure.
- [Verify my number with a code](https://docs.api.nkama.ga/api-reference/phone-verification/verify-my-number-with-a-code.md): Verifies the code and latches the caller's number as verified (204). 410 when the challenge is unknown/expired, 422 on a wrong code, 429 once locked out.
- [Get apiv1properties](https://docs.api.nkama.ga/api-reference/property-controller/get-apiv1properties.md)
- [Get apiv1properties 1](https://docs.api.nkama.ga/api-reference/property-controller/get-apiv1properties-1.md)
- [Get apiv1properties units](https://docs.api.nkama.ga/api-reference/property-controller/get-apiv1properties-units.md)
- [Get apiv1propertiesmine](https://docs.api.nkama.ga/api-reference/property-controller/get-apiv1propertiesmine.md)
- [Post apiv1properties](https://docs.api.nkama.ga/api-reference/property-controller/post-apiv1properties.md)
- [Post apiv1properties archive](https://docs.api.nkama.ga/api-reference/property-controller/post-apiv1properties-archive.md)
- [Post apiv1properties units](https://docs.api.nkama.ga/api-reference/property-controller/post-apiv1properties-units.md)
- [Post apiv1properties units availability](https://docs.api.nkama.ga/api-reference/property-controller/post-apiv1properties-units-availability.md)
- [Get apiv1verificationproperty proofs](https://docs.api.nkama.ga/api-reference/property-proof-controller/get-apiv1verificationproperty-proofs.md)
- [Get apiv1verificationproperty proofsmine](https://docs.api.nkama.ga/api-reference/property-proof-controller/get-apiv1verificationproperty-proofsmine.md)
- [Post apiv1verificationproperty proofs](https://docs.api.nkama.ga/api-reference/property-proof-controller/post-apiv1verificationproperty-proofs.md)
- [Post apiv1verificationproperty proofs documents](https://docs.api.nkama.ga/api-reference/property-proof-controller/post-apiv1verificationproperty-proofs-documents.md)
- [Post apiv1verificationproperty proofs submit](https://docs.api.nkama.ga/api-reference/property-proof-controller/post-apiv1verificationproperty-proofs-submit.md)
- [Complete sign-up](https://docs.api.nkama.ga/api-reference/registration/complete-sign-up.md): Redeems the registration ticket with the user's profile and password to create the account (phone is taken from the ticket, never the body). 422 when the ticket is expired/invalid, 409 if the number is already registered, 503 when account creation is unavailable.
- [Request a sign-up code](https://docs.api.nkama.ga/api-reference/registration/request-a-sign-up-code.md): Sends a one-time code to the phone number and returns a challenge. Set `whatsapp` to deliver over WhatsApp first (falling back to SMS). Rate-limited per number and per IP; only served calling codes are accepted (422 otherwise).
- [Verify the sign-up code](https://docs.api.nkama.ga/api-reference/registration/verify-the-sign-up-code.md): Verifies the code for the challenge and returns a single-use registration ticket. 410 when the challenge is unknown/expired, 422 on a wrong code, 429 once the attempt budget is spent.
- [Get apiv1adminverification](https://docs.api.nkama.ga/api-reference/verification-review-controller/get-apiv1adminverification.md)
- [Get apiv1adminverificationqueue](https://docs.api.nkama.ga/api-reference/verification-review-controller/get-apiv1adminverificationqueue.md)
- [Get apiv1adminverificationqueuecount](https://docs.api.nkama.ga/api-reference/verification-review-controller/get-apiv1adminverificationqueuecount.md)
- [Post apiv1adminverification approve](https://docs.api.nkama.ga/api-reference/verification-review-controller/post-apiv1adminverification-approve.md)
- [Post apiv1adminverification claim](https://docs.api.nkama.ga/api-reference/verification-review-controller/post-apiv1adminverification-claim.md)
- [Post apiv1adminverification reject](https://docs.api.nkama.ga/api-reference/verification-review-controller/post-apiv1adminverification-reject.md)
- [Post apiv1adminverification request info](https://docs.api.nkama.ga/api-reference/verification-review-controller/post-apiv1adminverification-request-info.md)
- [Post apiv1adminverification revoke](https://docs.api.nkama.ga/api-reference/verification-review-controller/post-apiv1adminverification-revoke.md)
- [Unimatrix delivery-report (DLR) callback](https://docs.api.nkama.ga/api-reference/webhooks/unimatrix-delivery-report-dlr-callback.md): Records a vendor delivery receipt (channel, status, masked destination) into the audit trail. Authenticated by the configured signature and/or `?token=`; 200 on accept, 401 on a bad token/signature, 503 when disabled.
- [Authentication](https://docs.api.nkama.ga/authentication.md): OpenID Connect via Keycloak — obtaining and using a bearer token.
- [Get started](https://docs.api.nkama.ga/getting-started.md): From zero to your first authenticated request.
- [Owner onboarding](https://docs.api.nkama.ga/guides/owner-onboarding.md): How a tenant becomes a verified owner and lists a property.
- [NKAMA API](https://docs.api.nkama.ga/index.md): Build on the NKAMA property rental & management platform.

## OpenAPI Specs

- [openapi](https://docs.api.nkama.ga/api-reference/openapi.json)