> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://apidocs.sare.africa/sare-core-api/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://apidocs.sare.africa/_mcp/server. # Overview Complete endpoint documentation for the Sare Core API (`/api/v3`). **Structure**: one top-level folder per Spring Modulith module (`Wallet`, `Identity`, `Location`, `Integrations`, `Notifications`, `Ussd`, `Waas` - matching `io.sare.sare_core.*` in CLAUDE.md), each containing one subfolder per controller/feature area. **Keep this pattern going forward**: a new endpoint nests under its module's top-level folder, in a new or existing subfolder named after its controller/feature - never as a new top-level folder. **Envelope**: success responses wrap the payload as `{ "code": int, "message": string, "data": T }` (`data` omitted when null). Errors are `{ "status": int, "message": string, "path": string }` (plus `stackTrace` if the server has `sare.stack.trace=true`). **Auth**: most endpoints need `Authorization: Bearer {{accessToken}}` (set after calling Login, under Identity > Auth). A request-signing filter also requires `X-Device-Id`/`X-Signature`/`X-Timestamp`/`X-Request-Id` headers on non-GET requests to non-public paths (skipped for GET requests, multipart requests, the `local` profile, and the whitelisted paths noted per-subfolder below) - included as disabled headers on relevant requests here since they require a real device keypair to compute correctly; set them via a pre-request script if you need to exercise that filter. **Fully public** (no Bearer token at all): `payments/**`, `auth/**` (except `auth/logout`/`auth/refresh-token`), `areas/**`, `counties/**`, `regions/**`, `wallets/register/**`, `waas/callbacks/choicebaas`, `devices/**`, `wallet/ussd/**`, `geolocation/reverse-geocode`, `users/appVersion`. Set the `baseUrl` collection variable to your target environment (default `http://localhost:8080/api/v3`). ## Docs - [Overview](https://apidocs.sare.africa/sare-core-api/wallet.md) - [Overview](https://apidocs.sare.africa/sare-core-api/wallet/wallet-banks.md) - [Overview](https://apidocs.sare.africa/sare-core-api/wallet/wallet-personal.md) - [Overview](https://apidocs.sare.africa/sare-core-api/wallet/wallet-business.md) - [Overview](https://apidocs.sare.africa/sare-core-api/wallet/wallet-bills-accounts-providers.md) - [Overview](https://apidocs.sare.africa/sare-core-api/wallet/wallet-transactions.md) - [Overview](https://apidocs.sare.africa/sare-core-api/wallet/wallet-auth-pin-recovery.md) - [Overview](https://apidocs.sare.africa/sare-core-api/identity.md) - [Overview](https://apidocs.sare.africa/sare-core-api/identity/identity-roles.md) - [Overview](https://apidocs.sare.africa/sare-core-api/identity/identity-users.md) - [Overview](https://apidocs.sare.africa/sare-core-api/identity/identity-devices.md) - [Overview](https://apidocs.sare.africa/sare-core-api/identity/identity-auth.md) - [Overview](https://apidocs.sare.africa/sare-core-api/identity/identity-permissions.md) - [Overview](https://apidocs.sare.africa/sare-core-api/identity/identity-accounts.md) - [Overview](https://apidocs.sare.africa/sare-core-api/location.md) - [Overview](https://apidocs.sare.africa/sare-core-api/location/location-areas.md) - [Overview](https://apidocs.sare.africa/sare-core-api/location/location-regions.md) - [Overview](https://apidocs.sare.africa/sare-core-api/location/location-counties.md) - [Overview](https://apidocs.sare.africa/sare-core-api/location/location-sub-regions.md) - [Overview](https://apidocs.sare.africa/sare-core-api/integrations.md) - [Overview](https://apidocs.sare.africa/sare-core-api/integrations/integrations-geolocation.md) - [Overview](https://apidocs.sare.africa/sare-core-api/notifications.md) - [Overview](https://apidocs.sare.africa/sare-core-api/notifications/notifications-manual-notifications.md) - [Overview](https://apidocs.sare.africa/sare-core-api/ussd.md) - [Overview](https://apidocs.sare.africa/sare-core-api/ussd/ussd-gateway-callback.md) - [Overview](https://apidocs.sare.africa/sare-core-api/waas.md) - [Overview](https://apidocs.sare.africa/sare-core-api/waas/waas-choice-bank-callback.md) ## API Docs - [Check Personal Wallet By Phone](https://apidocs.sare.africa/sare-core-api/wallet/check-personal-wallet-by-phone.md): Sare Core API > Wallet - [Create Personal Wallet](https://apidocs.sare.africa/sare-core-api/wallet/create-personal-wallet.md): Sare Core API > Wallet - [Upload Personal Wallet KYC Documents](https://apidocs.sare.africa/sare-core-api/wallet/upload-personal-wallet-kyc-documents.md): Sare Core API > Wallet - [Request Personal Onboarding OTP](https://apidocs.sare.africa/sare-core-api/wallet/request-personal-onboarding-otp.md): Sare Core API > Wallet - [Resend Personal Onboarding OTP](https://apidocs.sare.africa/sare-core-api/wallet/resend-personal-onboarding-otp.md): Sare Core API > Wallet - [Confirm Personal Onboarding OTP](https://apidocs.sare.africa/sare-core-api/wallet/confirm-personal-onboarding-otp.md): Sare Core API > Wallet - [Retry Personal Onboarding](https://apidocs.sare.africa/sare-core-api/wallet/retry-personal-onboarding.md): Sare Core API > Wallet - [Resubmit Personal Onboarding](https://apidocs.sare.africa/sare-core-api/wallet/resubmit-personal-onboarding.md): Sare Core API > Wallet - [Update Personal Wallet KYC Profile](https://apidocs.sare.africa/sare-core-api/wallet/update-personal-wallet-kyc-profile.md): Sare Core API > Wallet - [Get Current User's Wallet](https://apidocs.sare.africa/sare-core-api/wallet/get-current-users-wallet.md): Sare Core API > Wallet - [Get Wallets Status](https://apidocs.sare.africa/sare-core-api/wallet/get-wallets-status.md): Sare Core API > Wallet - [Get Wallet By Phone](https://apidocs.sare.africa/sare-core-api/wallet/get-wallet-by-phone.md): Sare Core API > Wallet - [Create Business Wallet](https://apidocs.sare.africa/sare-core-api/wallet/create-business-wallet.md): Sare Core API > Wallet - [Resend Business Onboarding OTP](https://apidocs.sare.africa/sare-core-api/wallet/resend-business-onboarding-otp.md): Sare Core API > Wallet - [Confirm Business Onboarding OTP](https://apidocs.sare.africa/sare-core-api/wallet/confirm-business-onboarding-otp.md): Sare Core API > Wallet - [Resubmit Business Onboarding](https://apidocs.sare.africa/sare-core-api/wallet/resubmit-business-onboarding.md): Sare Core API > Wallet - [Archive Business Wallet](https://apidocs.sare.africa/sare-core-api/wallet/archive-business-wallet.md): Sare Core API > Wallet - [Get Current User's Business Wallet](https://apidocs.sare.africa/sare-core-api/wallet/get-current-users-business-wallet.md): Sare Core API > Wallet - [Search Business By Sare Till](https://apidocs.sare.africa/sare-core-api/wallet/search-business-by-sare-till.md): Sare Core API > Wallet - [Opt In To Kibeti](https://apidocs.sare.africa/sare-core-api/wallet/opt-in-to-kibeti.md): Sare Core API > Wallet - [Opt Out Of Kibeti](https://apidocs.sare.africa/sare-core-api/wallet/opt-out-of-kibeti.md): Sare Core API > Wallet - [Setup Wallet PIN](https://apidocs.sare.africa/sare-core-api/wallet/setup-wallet-pin.md): Sare Core API > Wallet - [Verify Wallet PIN](https://apidocs.sare.africa/sare-core-api/wallet/verify-wallet-pin.md): Sare Core API > Wallet - [Get Available Recovery Questions](https://apidocs.sare.africa/sare-core-api/wallet/get-available-recovery-questions.md): Sare Core API > Wallet - [Get Configured Recovery Questions](https://apidocs.sare.africa/sare-core-api/wallet/get-configured-recovery-questions.md): Sare Core API > Wallet - [Save Recovery Questions](https://apidocs.sare.africa/sare-core-api/wallet/save-recovery-questions.md): Sare Core API > Wallet - [Change Wallet PIN](https://apidocs.sare.africa/sare-core-api/wallet/change-wallet-pin.md): Sare Core API > Wallet - [Request PIN Reset OTP](https://apidocs.sare.africa/sare-core-api/wallet/request-pin-reset-otp.md): Sare Core API > Wallet - [Verify PIN Reset OTP](https://apidocs.sare.africa/sare-core-api/wallet/verify-pin-reset-otp.md): Sare Core API > Wallet - [Verify PIN Reset Recovery Answer](https://apidocs.sare.africa/sare-core-api/wallet/verify-pin-reset-recovery-answer.md): Sare Core API > Wallet - [Complete PIN Reset](https://apidocs.sare.africa/sare-core-api/wallet/complete-pin-reset.md): Sare Core API > Wallet - [Get Wallet Statement](https://apidocs.sare.africa/sare-core-api/wallet/get-wallet-statement.md): Sare Core API > Wallet - [Email Statement](https://apidocs.sare.africa/sare-core-api/wallet/email-statement.md): Sare Core API > Wallet - [Get Last Statement Recipient](https://apidocs.sare.africa/sare-core-api/wallet/get-last-statement-recipient.md): Sare Core API > Wallet - [Deposit To Kibeti (From Personal)](https://apidocs.sare.africa/sare-core-api/wallet/deposit-to-kibeti-from-personal.md): Sare Core API > Wallet - [Withdraw From Kibeti (To Personal)](https://apidocs.sare.africa/sare-core-api/wallet/withdraw-from-kibeti-to-personal.md): Sare Core API > Wallet - [Confirm Kibeti Self-Transfer](https://apidocs.sare.africa/sare-core-api/wallet/confirm-kibeti-self-transfer.md): Sare Core API > Wallet - [Send Money To Personal Wallet](https://apidocs.sare.africa/sare-core-api/wallet/send-money-to-personal-wallet.md): Sare Core API > Wallet - [Pay Sare Till From Kibeti](https://apidocs.sare.africa/sare-core-api/wallet/pay-sare-till-from-kibeti.md): Sare Core API > Wallet - [Send Money To Kibeti Wallet](https://apidocs.sare.africa/sare-core-api/wallet/send-money-to-kibeti-wallet.md): Sare Core API > Wallet - [Pay M-PESA Till From Kibeti](https://apidocs.sare.africa/sare-core-api/wallet/pay-m-pesa-till-from-kibeti.md): Sare Core API > Wallet - [Pay M-PESA Paybill From Kibeti](https://apidocs.sare.africa/sare-core-api/wallet/pay-m-pesa-paybill-from-kibeti.md): Sare Core API > Wallet - [Send To Mobile Money From Kibeti](https://apidocs.sare.africa/sare-core-api/wallet/send-to-mobile-money-from-kibeti.md): Sare Core API > Wallet - [Initiate P2K Transfer (Personal to Kibeti)](https://apidocs.sare.africa/sare-core-api/wallet/initiate-p-2-k-transfer-personal-to-kibeti.md): Sare Core API > Wallet - [Initiate B2K Transfer (Sare Till to Kibeti)](https://apidocs.sare.africa/sare-core-api/wallet/initiate-b-2-k-transfer-sare-till-to-kibeti.md): Sare Core API > Wallet - [Query Bill](https://apidocs.sare.africa/sare-core-api/wallet/query-bill.md): Sare Core API > Wallet - [Initiate Bill Payment](https://apidocs.sare.africa/sare-core-api/wallet/initiate-bill-payment.md): Sare Core API > Wallet - [Confirm Bill Payment](https://apidocs.sare.africa/sare-core-api/wallet/confirm-bill-payment.md): Sare Core API > Wallet - [Confirm Bill Payment OTP](https://apidocs.sare.africa/sare-core-api/wallet/confirm-bill-payment-otp.md): Sare Core API > Wallet - [Initiate Airtime Purchase](https://apidocs.sare.africa/sare-core-api/wallet/initiate-airtime-purchase.md): Sare Core API > Wallet - [Confirm Airtime Purchase](https://apidocs.sare.africa/sare-core-api/wallet/confirm-airtime-purchase.md): Sare Core API > Wallet - [Confirm Airtime Purchase OTP](https://apidocs.sare.africa/sare-core-api/wallet/confirm-airtime-purchase-otp.md): Sare Core API > Wallet - [Initiate P2P Transfer](https://apidocs.sare.africa/sare-core-api/wallet/initiate-p-2-p-transfer.md): Sare Core API > Wallet - [Initiate P2B Transfer (Pay Sare Till)](https://apidocs.sare.africa/sare-core-api/wallet/initiate-p-2-b-transfer-pay-sare-till.md): Sare Core API > Wallet - [Confirm Transfer](https://apidocs.sare.africa/sare-core-api/wallet/confirm-transfer.md): Sare Core API > Wallet - [Confirm Transfer OTP](https://apidocs.sare.africa/sare-core-api/wallet/confirm-transfer-otp.md): Sare Core API > Wallet - [Get Transaction Details](https://apidocs.sare.africa/sare-core-api/wallet/get-transaction-details.md): Sare Core API > Wallet - [Initiate Withdrawal](https://apidocs.sare.africa/sare-core-api/wallet/initiate-withdrawal.md): Sare Core API > Wallet - [Confirm Withdrawal](https://apidocs.sare.africa/sare-core-api/wallet/confirm-withdrawal.md): Sare Core API > Wallet - [Confirm Withdrawal OTP](https://apidocs.sare.africa/sare-core-api/wallet/confirm-withdrawal-otp.md): Sare Core API > Wallet - [Deposit Via M-Pesa (STK Push)](https://apidocs.sare.africa/sare-core-api/wallet/deposit-via-m-pesa-stk-push.md): Sare Core API > Wallet - [Get Bill Payment Methods](https://apidocs.sare.africa/sare-core-api/wallet/get-bill-payment-methods.md): Sare Core API > Wallet - [Add Bill Account To Favourites](https://apidocs.sare.africa/sare-core-api/wallet/add-bill-account-to-favourites.md): Sare Core API > Wallet - [List Bill Accounts](https://apidocs.sare.africa/sare-core-api/wallet/list-bill-accounts.md): Sare Core API > Wallet - [Create Bill Account](https://apidocs.sare.africa/sare-core-api/wallet/create-bill-account.md): Sare Core API > Wallet - [Get Bill Account](https://apidocs.sare.africa/sare-core-api/wallet/get-bill-account.md): Sare Core API > Wallet - [Update Bill Account](https://apidocs.sare.africa/sare-core-api/wallet/update-bill-account.md): Sare Core API > Wallet - [Delete Bill Account](https://apidocs.sare.africa/sare-core-api/wallet/delete-bill-account.md): Sare Core API > Wallet - [Activate/Deactivate Bill Provider](https://apidocs.sare.africa/sare-core-api/wallet/activate-deactivate-bill-provider.md): Sare Core API > Wallet - [Approve/Reject Bill Provider](https://apidocs.sare.africa/sare-core-api/wallet/approve-reject-bill-provider.md): Sare Core API > Wallet - [List Bill Providers](https://apidocs.sare.africa/sare-core-api/wallet/list-bill-providers.md): Sare Core API > Wallet - [Create Bill Provider](https://apidocs.sare.africa/sare-core-api/wallet/create-bill-provider.md): Sare Core API > Wallet - [Get Bill Provider](https://apidocs.sare.africa/sare-core-api/wallet/get-bill-provider.md): Sare Core API > Wallet - [Update Bill Provider](https://apidocs.sare.africa/sare-core-api/wallet/update-bill-provider.md): Sare Core API > Wallet - [Delete Bill Provider](https://apidocs.sare.africa/sare-core-api/wallet/delete-bill-provider.md): Sare Core API > Wallet - [List Bill Provider Categories](https://apidocs.sare.africa/sare-core-api/wallet/list-bill-provider-categories.md): Sare Core API > Wallet - [List Bill Account Types](https://apidocs.sare.africa/sare-core-api/wallet/list-bill-account-types.md): Sare Core API > Wallet - [List Banks](https://apidocs.sare.africa/sare-core-api/wallet/list-banks.md): Sare Core API > Wallet - [Login](https://apidocs.sare.africa/sare-core-api/identity/login.md): Sare Core API > Identity - [Access Token (Client Login)](https://apidocs.sare.africa/sare-core-api/identity/access-token-client-login.md): Sare Core API > Identity - [Logout](https://apidocs.sare.africa/sare-core-api/identity/logout.md): Sare Core API > Identity - [Refresh Token](https://apidocs.sare.africa/sare-core-api/identity/refresh-token.md): Sare Core API > Identity - [Check Phone](https://apidocs.sare.africa/sare-core-api/identity/check-phone.md): Sare Core API > Identity - [Check Email](https://apidocs.sare.africa/sare-core-api/identity/check-email.md): Sare Core API > Identity - [Request OTP](https://apidocs.sare.africa/sare-core-api/identity/request-otp.md): Sare Core API > Identity - [Verify OTP](https://apidocs.sare.africa/sare-core-api/identity/verify-otp.md): Sare Core API > Identity - [Get Device-Change Security Questions](https://apidocs.sare.africa/sare-core-api/identity/get-device-change-security-questions.md): Sare Core API > Identity - [Verify Device-Change Security Answer](https://apidocs.sare.africa/sare-core-api/identity/verify-device-change-security-answer.md): Sare Core API > Identity - [Add Security Question (Admin)](https://apidocs.sare.africa/sare-core-api/identity/add-security-question-admin.md): Sare Core API > Identity - [Register Device](https://apidocs.sare.africa/sare-core-api/identity/register-device.md): Sare Core API > Identity - [List Users](https://apidocs.sare.africa/sare-core-api/identity/list-users.md): Sare Core API > Identity - [Create User](https://apidocs.sare.africa/sare-core-api/identity/create-user.md): Sare Core API > Identity - [Create Client User](https://apidocs.sare.africa/sare-core-api/identity/create-client-user.md): Sare Core API > Identity - [Get User](https://apidocs.sare.africa/sare-core-api/identity/get-user.md): Sare Core API > Identity - [Update User](https://apidocs.sare.africa/sare-core-api/identity/update-user.md): Sare Core API > Identity - [Delete User](https://apidocs.sare.africa/sare-core-api/identity/delete-user.md): Sare Core API > Identity - [Get App Version](https://apidocs.sare.africa/sare-core-api/identity/get-app-version.md): Sare Core API > Identity - [List Roles](https://apidocs.sare.africa/sare-core-api/identity/list-roles.md): Sare Core API > Identity - [Create Role](https://apidocs.sare.africa/sare-core-api/identity/create-role.md): Sare Core API > Identity - [Get Role Groups](https://apidocs.sare.africa/sare-core-api/identity/get-role-groups.md): Sare Core API > Identity - [Get Role](https://apidocs.sare.africa/sare-core-api/identity/get-role.md): Sare Core API > Identity - [Update Role](https://apidocs.sare.africa/sare-core-api/identity/update-role.md): Sare Core API > Identity - [Delete Role](https://apidocs.sare.africa/sare-core-api/identity/delete-role.md): Sare Core API > Identity - [List Permission Groups](https://apidocs.sare.africa/sare-core-api/identity/list-permission-groups.md): Sare Core API > Identity - [List Areas](https://apidocs.sare.africa/sare-core-api/location/list-areas.md): Sare Core API > Location - [Create Area](https://apidocs.sare.africa/sare-core-api/location/create-area.md): Sare Core API > Location - [Get Area](https://apidocs.sare.africa/sare-core-api/location/get-area.md): Sare Core API > Location - [Update Area](https://apidocs.sare.africa/sare-core-api/location/update-area.md): Sare Core API > Location - [Delete Area](https://apidocs.sare.africa/sare-core-api/location/delete-area.md): Sare Core API > Location - [Assign Users To Area](https://apidocs.sare.africa/sare-core-api/location/assign-users-to-area.md): Sare Core API > Location - [Get Users Assigned To Area](https://apidocs.sare.africa/sare-core-api/location/get-users-assigned-to-area.md): Sare Core API > Location - [Unassign Users From Area](https://apidocs.sare.africa/sare-core-api/location/unassign-users-from-area.md): Sare Core API > Location - [List Counties](https://apidocs.sare.africa/sare-core-api/location/list-counties.md): Sare Core API > Location - [Enable Counties](https://apidocs.sare.africa/sare-core-api/location/enable-counties.md): Sare Core API > Location - [Get County Detail](https://apidocs.sare.africa/sare-core-api/location/get-county-detail.md): Sare Core API > Location - [Disable County](https://apidocs.sare.africa/sare-core-api/location/disable-county.md): Sare Core API > Location - [List Regions](https://apidocs.sare.africa/sare-core-api/location/list-regions.md): Sare Core API > Location - [Create Region](https://apidocs.sare.africa/sare-core-api/location/create-region.md): Sare Core API > Location - [Get Region Detail](https://apidocs.sare.africa/sare-core-api/location/get-region-detail.md): Sare Core API > Location - [Update Region](https://apidocs.sare.africa/sare-core-api/location/update-region.md): Sare Core API > Location - [Delete Region](https://apidocs.sare.africa/sare-core-api/location/delete-region.md): Sare Core API > Location - [List Sub Regions By Region](https://apidocs.sare.africa/sare-core-api/location/list-sub-regions-by-region.md): Sare Core API > Location - [Get Sub Region Detail](https://apidocs.sare.africa/sare-core-api/location/get-sub-region-detail.md): Sare Core API > Location - [Update Sub Region](https://apidocs.sare.africa/sare-core-api/location/update-sub-region.md): Sare Core API > Location - [Delete Sub Region](https://apidocs.sare.africa/sare-core-api/location/delete-sub-region.md): Sare Core API > Location - [List Sub Regions](https://apidocs.sare.africa/sare-core-api/location/list-sub-regions.md): Sare Core API > Location - [Create Sub Region](https://apidocs.sare.africa/sare-core-api/location/create-sub-region.md): Sare Core API > Location - [Reverse Geocode](https://apidocs.sare.africa/sare-core-api/integrations/reverse-geocode.md): Sare Core API > Integrations - [Send Manual Notification](https://apidocs.sare.africa/sare-core-api/notifications/send-manual-notification.md): Sare Core API > Notifications - [Register Notification Device Token](https://apidocs.sare.africa/sare-core-api/notifications/register-notification-device-token.md): Sare Core API > Notifications - [USSD Gateway Callback](https://apidocs.sare.africa/sare-core-api/ussd/gateway-callback.md): Sare Core API > Ussd - [Choice Bank Notification Callback (0003 Balance Change example)](https://apidocs.sare.africa/sare-core-api/waas/choice-bank-notification-callback-0003-balance-change-example.md): Sare Core API > Waas ## OpenAPI Specification - [OpenAPI JSON](https://apidocs.sare.africa/openapi.json): raw OpenAPI 3.1 specification for this API, JSON format - [OpenAPI YAML](https://apidocs.sare.africa/openapi.yaml): raw OpenAPI 3.1 specification for this API, YAML format