For AI agents: visit https://developers.85.group/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Guides
API Reference
v1.0
API Reference
Log In
Jump to Content
v1.0
Guides
API Reference
My Requests
Log In
Getting Started
Authentication
My Requests
Authentication
MVNO Auth
MVNO user login
post
Refresh MVNO access token
post
Logout current session
post
Logout all sessions
post
Look up invite info by token
get
Accept invite, set password, log in
post
Request MVNO password reset OTP
post
Verify MVNO password reset OTP and set new password
post
Partner Auth
Partner user login
post
Refresh partner access token
post
Logout current session
post
Logout all sessions
post
Switch active partner context
post
Switch active partner membership (rica-portal attribution)
post
Look up partner invite info by token
get
Accept partner invite and set password
post
Request partner password reset OTP
post
Verify partner password reset OTP and set new password
post
Look up a RICA agent invite by token
get
Accept a RICA agent invite and set password
post
App Users
App User Account Recovery
Request OTP to recover forgotten username
post
Verify OTP and send recovered username(s) by SMS
post
Request password reset OTP
post
Verify password reset
post
App User Ads
Ad status
get
Complete ad view
post
Serve a house ad
post
Start the watch clock for a served ad
post
App User Authentication
Login with username and password
post
Request passwordless login OTP
post
Verify passwordless login OTP
post
Refresh access token
post
Logout current session
post
Logout all sessions
post
Enrol this device for biometric login
post
Re-mint a session from a trusted-device token
post
Revoke a trusted device ("forget this device")
post
App User Banners
List banners for the app user
get
App User Cards
Generate hosted add-card form for the current app user
post
List current app user cards
get
Start 3DS verification for current app user card
post
Get 3DS verification status for current app user card
get
Clear current app user card verification record
del
Delete current app user card
del
App User Entity
Get the caller’s compliance entity
get
List KYC documents on the caller’s entity
get
Upload a KYC document against the caller’s entity
post
RICA compliance status for the caller’s entity
get
FICA compliance status for the caller’s entity
get
FICA limits for the caller’s wallet tier
get
App User Games
List games
get
Report game progress
post
Claim daily game reward
post
App User KeyFund
List KeyFund customer FAQs
get
Get the current app user KeyFund plan
get
Submit a KeyFund cash-out or reinvest instruction (deprecated)
post
Submit an idempotent KeyFund cash-out or reinvest instruction
post
App User Loyalty
List app-user loyalty programs
get
Get the current app user loyalty membership
get
Enroll the current app user in a loyalty program
post
Check whether the current app user is enrolled
get
Get current loyalty reward progress
get
App User Me
Get own profile (shortcut)
get
Personal information composite (profile + RICA)
get
Update personal information
patch
Settings landing screen summary
get
Get own notification preferences
get
Update own notification preferences
patch
Get own address
get
Update own address
patch
Upload own avatar
post
List linked accounts for the current app user
get
Link an account for the current app user
post
Verify an account link for the current app user
post
Resend an account-link OTP for the current app user
post
Unlink an account for the current app user
del
Set the current app user primary linked account
post
Upsert the current app user device consent
put
Get own marketing consent preferences
get
Update own marketing consent preferences
patch
App User Migration
Verify legacy phone and PIN
post
Complete legacy migration
post
Request a legacy migration recovery code
post
Verify a legacy migration recovery code
post
App User Please Call Me
Send a Please Call Me request from a linked subscriber line
post
App User Product Categories
Available product categories
get
Product category detail
get
App User Products
Available products
get
Product detail
get
App User Purchases
Initiate an MVNO purchase for the current app user
post
Initiate a marketplace voucher purchase for the current app user
post
Initiate a bill-payment purchase for the current app user
post
Initiate a cellular purchase for the current app user
post
Initiate a prepaid electricity purchase for the current app user
post
Initiate a Free Basic Electricity purchase for the current app user
post
App User Recipients
List recipients for the authenticated user
get
Create a saved recipient
post
Get a recipient by UUID
get
Update recipient cosmetic fields
patch
Soft-delete a recipient
del
Update last_used_at timestamp
post
Pre-flight MSISDN lookup
post
App User Reference
Mobile network providers (signup dropdown)
get
App User Registration
Request phone OTP for new registration
post
Verify phone OTP for registration
post
Check username availability
post
Register a new app user
post
Verify registration email address
post
Resend email verification OTP
post
App User Rewards
List rewards
get
Reward summary
get
Reward performance
get
Pending rewards
get
Rewards overview
get
Spend requirements
get
Allocated reward history
get
Pending rewards by spend tier
get
Get reward detail
get
Active offers
get
Rewards config
get
App User Security
Set initial password
post
Change password
post
List active sessions
get
Revoke a session
del
List registered devices
get
Trust a device
post
Block a device
post
Unblock a device
del
List suspicious devices
get
List recovery methods
get
Get security settings summary
get
Request recovery phone verification OTP
post
Verify recovery phone
post
Request recovery email verification OTP
post
Verify recovery email
post
App User Surveys
Available surveys
get
Survey detail
get
Submit survey responses
post
Start survey
post
App User Transfers
Send airtime to another account by MSISDN
post
App User Wallets
Get wallet details for the current app user
get
Create wallet for the current app user
post
List saved wallet recipients for the current app user
get
Create a saved MyWallet recipient by MSISDN or wallet account number
post
Send wallet funds to a saved MyWallet recipient
post
Send wallet funds to another MyWallet holder by MSISDN or wallet account number
post
Compatibility alias for GET /app-user/wallet/recipients?type=bank_account
get
Create a bank-account wallet recipient
post
Compatibility alias for paying a saved bank recipient
post
Deposit real money into the current app user wallet
post
Get EFT deposit banking details for the current app user wallet
get
Generate Proof of Account PDF for the current app user wallet
get
Resolve an active MyWallet account number
get
Create a wallet cash-out withdrawal request
post
Get wallet withdrawal request status
get
Get the consumer wallet fee schedule
get
Quote a consumer wallet fee
post
List wallet-ledger transactions for the current app user
get
Delete an owned saved MyWallet recipient
del
Delete a saved bank beneficiary
del
App User Porting
Start a port-in request for a linked active account
post
Get the latest port-in request for a linked account
get
App User SPAR Rewards
Get SPAR Rewards linking status
get
Get SPAR Rewards card barcode number
get
Send SPAR Rewards switch OTP
post
Verify SPAR Rewards switch OTP
post
Register or reactivate SPAR Rewards profile
post
Find nearby SPAR stores
get
App User Age Verification
Get app-user age-verification terms
get
Confirm app-user DOB and terms acceptance
post
App User FICA
Get current app-user wallet FICA status
get
Create an app-user wallet FICA tier upgrade request
post
Resend an existing app-user wallet FICA verification link
post
App User Push Subscriptions
Register or update this device for push delivery
put
Deactivate push delivery for this device
del
App User Payment Capabilities
Get payment capabilities for the current app user
get
App User Custom Links
List custom menu links for the app user
get
MVNO
Accounts
List accounts
get
Get account
get
Get account by phone number
get
Search account for linking
get
Get account history
get
Suspend account
post
Unsuspend account
post
Port out
post
Manually reassign account MSISDN (deprecated, not MNP)
post
Link account to app user (admin)
post
Get account balance
get
Get partner accounts
get
Get partner account statistics
get
Get account DMA ledger
get
Get raw Totogi account JSON
get
List visible account UUID lookup batches
get
Upload an account UUID lookup CSV batch
post
Create a manual account UUID lookup batch
post
Get account UUID lookup batch metadata
get
Get completed manual account UUID lookup rows
get
Retry a failed account UUID lookup batch
post
Download a completed account UUID lookup CSV
get
List visible wallet account lookup batches
get
Upload a wallet account lookup CSV batch
post
Create a manual wallet account lookup batch
post
Get wallet account lookup batch metadata
get
Get completed manual wallet account lookup rows
get
Retry a failed wallet account lookup batch
post
Download a completed wallet account lookup CSV
get
Resolve account UUIDs, app user UUIDs, or wallet account numbers to MSISDNs
post
Agent Sales
Agent dashboard sales statistics (Rover POS parity)
get
Verify SIM ICCID for agent sale / RICA (Rover POS parity)
get
Agent SIM card sale price (Rover POS parity)
get
Agent performance overview statistics (Rover POS parity)
get
Agent transaction history (Rover POS parity)
get
Validate SA ID for RICA (Rover POS parity)
post
RICA per-ID SIM limit check (Rover POS parity)
post
Validate SA postal code for RICA (Rover POS parity)
post
RICA registration statistics for partner store (Rover POS parity)
post
Submit RICA registration for an authenticated agent
post
RICA distributor configuration (Rover POS parity)
post
Update SIM external ID after RICA (Rover POS parity)
post
Create SIM card cash sale (Rover POS parity)
post
Agents
Get all partner assignments for an agent
get
Assign agent to a partner
post
Remove agent assignment from a partner
del
Get activations for an agent with optional filters
get
Record an activation performed by an agent
post
Get activation statistics for an agent
get
App Users
List app users
get
Get app user
get
Update app user
patch
Get linked accounts (admin lookup)
get
Get wallet details for an app user
get
Create wallet for an app user
post
Create a recipient for an app user (admin)
post
Deposit real money into an app user wallet
post
List app user device consents
get
List wallet transactions for an app user
get
List visible app-user UUID lookup batches
get
Upload an app-user UUID lookup CSV batch
post
Create a manual app-user UUID lookup batch
post
Get app-user UUID lookup batch metadata
get
Get completed manual app-user UUID lookup rows
get
Retry a failed app-user UUID lookup batch
post
Download a completed app-user UUID lookup CSV
get
Banners
Create a banner
post
List banners
get
Get banner by UUID
get
Update banner
patch
Upload banner image
post
Get a fresh signed read URL for the banner image
get
Reorder banners (matches current list filters, single scope)
post
Public banner image proxy
get
Cards
Generate hosted add-card form for a user
post
Validate hosted add-card callback
post
List cards for a specific user
get
List all merchant cards
get
Delete a tokenised card
del
Start 3DS verification for a tokenised card
post
Get 3DS verification status for a tokenised card
get
Clear 3DS verification record for a tokenised card
del
Manually mark a tokenised card as verified
post
Render a secure Ecentric browser POST form
get
Render hosted add-card result page
get
Commissions
List commissions
get
Get commission summary
get
Get commission
get
Calculate commission
post
List settlements
get
Create settlement
post
Get settlement
get
Config
Get public feature flags — no authentication required
get
About screen metadata — no authentication required
get
Terms of Service inline content
get
Privacy Policy inline content
get
DMA
List DMA events
get
List steps for a DMA event
get
Retry a FAILED or OPS_QUEUE event
post
Force-rerun a single step
post
Sandbox: re-run the 7 Totogi steps for an existing account
post
Sandbox: publish a synthetic DMA event through Polaris
post
Entities
Create a new entity (person or business)
post
/api/v1/entities/{entityUuid}
get
Update an entity
patch
/api/v1/entities/lookup/{idType}/{idNumber}
get
/api/v1/entities/{entityUuid}/documents
get
Upload a KYC document against an entity
post
/api/v1/entities/documents/{documentUuid}/verify
patch
/api/v1/entities/{entityUuid}/rica/verify
post
/api/v1/entities/{entityUuid}/rica/reject
post
/api/v1/entities/{entityUuid}/rica/compliance
get
/api/v1/entities/{entityUuid}/fica/verify
post
/api/v1/entities/{entityUuid}/fica/compliance
get
/api/v1/entities/{entityUuid}/fica/limits
get
SIM usage for an entity
get
List compliance entities
get
List Sumsub verification requests for an entity
get
Send a Sumsub verification link for an entity
post
Entity Verification
List verification runs. Defaults to runs in OPS_QUEUE — pass status to override.
get
Get a verification run with steps + events
get
Reset a parked step and resume the run
post
Refresh the short-lived Sumsub URL behind a stable public RICA link
post
Backfill central Polaris routes for existing Sumsub applicants
post
FICA
Resolve caller FICA context
get
Look up an existing FICA entity by organisation type and legal identifier
get
Persist a reusable natural-person entity before attaching them to a FICA role
post
Resolve and attach a registered business FICA entity
post
Create or update caller FICA draft
post
Update caller FICA draft fields
patch
Submit caller FICA draft for review
post
Request provider verification for a FICA requirement, such as sending a SumSub biometric link
post
Approve submitted organisation FICA
post
Reject submitted organisation FICA
post
Resolve partner FICA context
get
Create or update draft FICA for a partner
post
Update draft FICA fields
patch
Submit FICA draft for review
post
Approve a submitted FICA (MVNO admin only)
post
Reject a submitted FICA (MVNO admin only)
post
Terminate the partner compliance relationship (RMCP §4.4–4.7). Records justification and flips FICA to EXPIRED.
post
Record a sanctions / TFS / PEP / adverse-media screening result against the partner Entity (RMCP §5.6). Provider-agnostic.
post
Look up an existing FICA entity by organisation type and legal identifier
get
Persist a reusable natural-person entity before attaching them to a FICA role
post
Request provider verification for a FICA requirement, such as sending a SumSub biometric link
post
Resolve and attach a registered business FICA entity from Datanamix
post
Resolve and upsert an authoritative South African person through Datanamix
post
Waive a Datanamix verification requirement the registry cannot evidence
post
Re-run the Datanamix company check for the caller FICA case
post
Resolve and upsert an authoritative South African person through Datanamix
post
Waive a Datanamix verification requirement the registry cannot evidence (MVNO admin only)
post
Re-run the Datanamix company check for a FICA case under review (MVNO admin only)
post
FICA Admin
List partner FICA submissions filtered by status
get
List partner compliance events (review queue + history). RMCP §6.1, §4.4–4.7, §4.8, §6.4.
get
Mark a compliance event resolved with notes (CO action)
post
Finance Quotes
List finance quotes
get
Get a finance quote
get
Update a finance quote line discount
patch
Approve a finance quote
post
Reject a finance quote
post
Raise a Xero invoice for an approved quote
post
Sync Xero payment status for an invoiced quote
post
Fulfil a paid finance quote
post
Mark a finance quote line as fulfilled
post
List finance quotes for review
get
Get a finance quote for review
get
Finance
Get the finance Xero contact status
get
Create the finance Xero contact from the linked legal entity
post
Get the finance Xero statement
get
Get the finance owner's row from the Aged Receivables report
get
List recent statement requests for the partner
get
Open a Jira ticket asking finance to email the official statement
post
List products available for finance quotes
get
Create a finance quote request
post
Get operational finance summary
get
Get uninvoiced invoiceable finance events
get
Get failed finance projection work items
get
Get the finance Xero contact details
get
Update finance Xero contact details
put
Games
Create draft game (admin)
post
List all games (admin)
get
Get game (admin)
get
Update game (admin)
patch
Health
Deployment version endpoint
get
KeyFund
Ingest KeyFund customer plan data
post
Resolve a migrated KeyFund sub-distributor
get
Loyalty Programs
List loyalty programs
get
Loyalty Rules
List loyalty rules
get
Create a loyalty rule
post
Get a loyalty rule by UUID
get
Activate or deactivate a loyalty rule
patch
Merchant Accounts
List merchant accounts
get
Look up compliance entity by ID number (person) or registration number (business)
get
Create and provision a merchant account
post
Get a single merchant account
get
Update a merchant account
patch
Delete a merchant account
del
Set the default merchant funding account
post
Deactivate a merchant account
post
Get wallet balance for a merchant account
get
List all supported bank codes
get
Get wallet balance by raw account number
get
List transactions for a merchant wallet account
get
List recipients (beneficiaries) for a merchant account
get
Add a recipient to a merchant wallet account
post
Pay a recipient from a merchant wallet account
post
List statements for a merchant wallet account
get
Request a new account statement
post
Get merchant wallet deposit options
get
Deposit into a merchant wallet using a card
post
Look up a customer wallet account by UUID or wallet account number
get
Transfer funds to a single customer wallet account
post
List merchant account wallet batches
get
Upload a merchant account wallet batch CSV or JSON body
post
Get a merchant account wallet batch with its transactions
get
Process a merchant account wallet batch
post
Get expanded details for a single merchant wallet transaction, including direction and state
get
MSISDN Pool
Import MSISDNs
post
Get pool statistics
get
Release quarantine
post
MVNO Config
List MVNO config entries (paginated)
get
Create a new MVNO config entry
post
Seed all default MVNO configs
post
Get MVNO config by key
get
Update MVNO config by key
patch
Delete MVNO config by key
del
Get app-user payment capabilities policy
get
Update app-user payment capabilities policy
patch
MVNO Profile
Current user profile
get
Update own profile
patch
Change own password
post
Accept Partner RICA terms before first capture
post
MVNO Users
Roles the current actor can assign
get
List MVNO users
get
Create an MVNO user (sends invite email)
post
Get a single MVNO user
get
Update an MVNO user
patch
Soft-delete an MVNO user
del
Resend invite email
post
Send password-reset OTP to user
post
Lookup MVNO user identity by email
get
Deactivate all MVNO and partner portal access for an identity
post
MVNO Webhooks
Get MVNO webhook dashboard state
get
Configure MVNO global webhooks
post
Notifications
Get list of notifications
get
Create a notification (admin only)
post
Get total unread notifications count
get
Mark a single notification as read
patch
Mark all notifications as read
patch
Get notification detail by id
get
Partner Agents
List agents managed by a leaf partner
get
Create a commission-earning agent
post
Get a commission-earning agent
get
Update a commission-earning agent
patch
Get the current agent commercial profile
get
Get agent FICA context
get
Get my agent FICA context
get
Re-issue agent invite token + email
post
Test CyclePay checkAgent lookup for an agent email
post
Test CyclePay ensureAgent for an agent email
post
Look up a shared portal identity for an agent
get
Partner Groups
List all partner groups
get
Create a new partner group
post
Get a partner group by UUID
get
Update a partner group
patch
List all partners in a group
get
Add a partner to the group
post
Remove a partner from the group
del
Partner Levels
List all partner levels
get
Create a new partner level
post
List only active partner levels
get
Get a partner level by UUID
get
Update a partner level
patch
Partner Payment Methods
List partner payment methods
get
Generate partner hosted add-card form
post
Start 3DS verification for a partner card
post
Get partner card verification status
get
Delete partner payment card
del
Partner payment-method 3DS ACS TermURL callback
post
Partner Profile
Current partner user profile
get
Update own profile
patch
Change own password
post
Accept Partner RICA terms before first capture
post
Partner RICA
List MVNO-level RICA records
get
Create a RICA draft (agent capture)
post
Get a RICA record by UUID
get
Update a RICA draft (agent capture)
patch
Upload a KYC document for a RICA draft
post
Submit and complete a Partner RICA (no separate approver)
post
Verify or reject an individual document
patch
Recovery: link a SIM (by ICCID) to a verified RICA entity
post
List DMA events stuck in PENDING_RICA
get
Retry a stuck PENDING_RICA DMA event
post
List RICA portal registrations visible to the caller
get
Summarize RICA light draft funnel statistics
get
Reveal a RICA registration contact number
post
Get a signed preview URL for a RICA document
get
Express reverify against an already-verified entity
post
Summarize RICA registration outcomes visible to the caller
get
Look up an existing subscriber entity for Partner RICA capture
get
Queue a post-RICA eSIM email resend
post
Partner RICA - Agent
Counts of RICA work attributed to this partner user (portal + maker/checker)
get
Partner Users
Add an existing shared identity or invite a new partner user
post
Get a single partner user
get
Update a partner user (membership at this partner)
patch
Roles the current actor can assign at this partner
get
List partner users
get
Soft-delete partner user membership
del
Re-issue partner invite token + email
post
Send password-reset OTP to user
post
List partner users across all partners
get
Look up a shared portal identity by email
get
Partners
List partners
get
Create partner
post
Get partner
get
Update partner
patch
Toggle comprehensive RICA flow for a partner
patch
Deactivate partner
post
Move partner
post
Get direct children
get
Get all descendants
get
Get ancestors
get
Get partner rewards summary
get
List partners that can fund sales
get
Get the MVNO head-office partner selection
get
Select the active root partner used for BAP stock
patch
Product Categories
Get all product categories (flat or tree)
get
Create a new product category
post
Get product category by UUID
get
Update product category
patch
Soft delete product category
del
Reorder all siblings in one group (one transaction)
post
Product Types
Get all product types
get
Create a new product type
post
Get product type by UUID
get
Update product type
patch
Soft delete product type
del
Products
Get all products with filtering and pagination
get
Create a new product
post
Get product by UUID
get
Update product
patch
Soft delete product
del
Purchase Transactions
List purchase transactions
get
Count purchase transactions by status
get
Get purchase transaction detail
get
Resolve an ops-queue purchase transaction
post
Add a note to a purchase transaction
post
Purchases
List ops-queue transactions
get
Get ops-queue transaction detail
get
Resolve an ops-queue transaction
post
Add a note to an ops-queue transaction
post
Get purchase transaction by UUID
get
Get purchase transaction status
get
Resolve a voucher PIN across providers (USSD)
post
Charge upfront for a RICA starter bundle before DMA activation
post
Read a pre-DMA bundle order
get
Initiate an MVNO purchase for a specified app user
post
Redeem a voucher into an MVNO product
post
Initiate a marketplace voucher purchase for a specified app user
post
Initiate a bill-payment purchase for a specified app user
post
Initiate a cellular purchase for a specified app user
post
Initiate a prepaid electricity purchase for a specified app user
post
Initiate a Free Basic Electricity purchase for a specified app user
post
Ozow payment success browser return
get
Ozow payment cancel browser return
get
Ozow payment error browser return
get
Retry an eligible failed purchase step
post
Retry provider-aware payment reversal
post
Reconcile an ambiguous Ozow payment with provider evidence
post
Reward Codes
Get reward code status
get
Redeem reward code
post
Rewards
Create reward
post
Get reward
get
Retry pending reward processing
post
Expire old rewards
post
List account rewards
get
List partner rewards
get
Create partner reward-code batch
post
Spend requirements (MVNO / API-key)
get
Get MVNO rewards summary
get
List Pulse products (partner-scoped)
get
Create a Pulse product
post
Get a Pulse product by UUID
get
Update a Pulse product — GTIN is immutable
put
Validate a batch of CSV product lines
post
Bulk upsert products from a validated CSV batch
post
List LEAF partners as store options
get
Distinct LSM cluster values from partners
get
Distinct region values from partners
get
Count LEAF stores matching LSM/region scope filters
get
List Pulse reward rules (paginated)
get
Create a Pulse reward rule
post
Get a Pulse reward rule by UUID
get
Update a Pulse reward rule
put
Soft-delete a Pulse reward rule
del
Toggle Pulse reward rule status
patch
Get Pulse reward rule status history
get
Get temporary Pulse runtime and shadow-validation telemetry
get
Get safe details for a Pulse parity report
get
List report-scoped customer-not-found baskets
post
Get a report-scoped customer-not-found basket
get
List sanitized Pulse operations failures
get
Get sanitized Pulse failure audit detail
get
Publish a Pulse failure to the isolated retry topic
post
Dismiss a Pulse operations failure
post
RICA (public)
Submit a RICA registration (self-service or agent-attributed)
post
Create a resumable public RICA draft
post
Read a resumable public RICA draft
get
Update public RICA draft progress and values
patch
Upload the selfie for a public RICA draft
post
Submit a saved public RICA draft
post
Pre-check whether a RICA identity already exists
post
Send a contact-number OTP for a public RICA submission
post
Verify a contact-number OTP for a public RICA submission
post
Send an email OTP for a public RICA submission
post
Verify an email OTP for a public RICA submission
post
Check RICA SIM limit status for an identity
post
Request a RICA SIM limit increase for the current count plus five
post
Reserve an eSIM for an authenticated partner agent
post
List starter packs with available eSIM stock for an agent
get
Roles
Get all roles with their permissions
get
Create a new role
post
Get all permissions
get
Get permissions grouped by resource
get
Update a role
put
Delete a role
del
Assign permissions to a role
post
Unassign permissions from a role
del
Sales
Initiate an MVNO product sale
post
Initiate a marketplace voucher sale
post
Initiate a bill-payment sale
post
Initiate a cellular sale
post
Initiate a prepaid electricity sale
post
Initiate a Free Basic Electricity sale
post
SIM Cards
Import SIM cards
post
List SIM cards
get
Get inventory statistics
get
Get SIM card
get
Get SIM by ICCID
get
Get SIM history
get
Allocate SIM cards
post
Allocate SIM count
post
Unallocate SIM
post
RICA registration
post
Request SIM swap
post
Get partner SIM cards
get
Get partner inventory
get
Receive SIM stock for a partner (MVNO, bulk delta)
post
Partner receive — scan box labels and claim all eligible SIMs
post
List SIM boxes (paginated, filterable, aggregated)
get
List available boxes for consignment loading (MVNO only)
get
Receive SIM stock (partner token; path must be active partner)
post
Receive SIMs by box label for a specific partner
post
Partner receive preview - validate box labels without claiming SIMs
post
Search SIM inventory by ICCID or box label
get
List SIM swap processes
get
Get SIM swap process detail
get
List SIM cards pending DMA activation
get
List eSIMs ready for partner RICA
get
Download visible SIM cards in a box as CSV
get
Get scoped SIM box detail and SIM cards
get
SIM Cards (public)
Look up a SIM by ICCID for RICA eligibility
get
SIM Consignments
List sim consignments
get
Create consignment in DRAFT
post
/api/v1/sim-consignments/{simConsignmentUuid}
get
/api/v1/sim-consignments/{simConsignmentUuid}
patch
Delete a DRAFT consignment
del
Return a DISPATCHED consignment back to DRAFT
post
/api/v1/sim-consignments/{simConsignmentUuid}/sims
post
List boxes involved in a consignment (derived from SIMs)
get
Attach boxes (by label) to a DRAFT consignment
post
Detach a box from a DRAFT consignment
del
Receive (GRV) a DISPATCHED consignment — partner action
post
Starter Packs
List starter packs (paginated)
get
Create a starter pack (MVNO SUPER_ADMIN)
post
Get starter pack by UUID
get
Update starter pack
patch
Archive starter pack (soft-delete)
del
Subscriptions
List active subscriptions
get
Download active subscriptions as CSV
get
List available subscription products
get
List subscription batch requests
get
Create a subscription batch from a CSV file or JSON rows — returns batchUuid immediately
post
Get batch request detail with rows
get
Trigger batch processing — batch must be in VALID status
post
Replace an unprocessed subscription batch with corrected CSV or JSON rows
patch
Summarise subscription billing owners
get
List subscription billing events
get
Summarise subscription billing events
get
Download subscription billing events as CSV
get
Generate invoice PDF for a billing event
post
Download generated invoice PDF
get
Email generated invoice PDF link
post
List billing events for one subscription
get
List subscription batch detail rows
get
Surveys
Create draft survey (admin)
post
List all surveys (admin)
get
Get survey (admin)
get
Update survey (admin)
patch
Update survey questions (admin)
patch
Survey statistics (admin)
get
Third Party Providers
List all third-party providers
get
Register a new third-party provider
post
Get a third-party provider by ID
get
Update a third-party provider
patch
Get sales and commission summary for a provider
get
Deactivate a third-party provider
patch
Third Party Sales
List all third-party sales
get
Get a third-party sale by ID
get
Update the status of a third-party sale
patch
Transaction Types
List transaction types
get
Create transaction type
post
Get transaction type
get
Seed default types
post
Transactions
List transactions
get
Create transaction
post
Get transaction
get
Get transaction status
get
Reverse transaction
post
Get account transactions
get
Transfers
Execute an airtime transfer between accounts
post
List airtime transfers requiring ops attention
get
Retry receiver credit for an airtime transfer in ops queue
post
Credit the sender back and mark an ops-queue transfer reversed
post
Get an airtime transfer by transaction UUID
get
Vendors
Get all vendors with filtering and pagination
get
Create a new vendor
post
Get vendor by UUID
get
Update vendor
patch
Soft delete vendor
del
Sync vendor products from upstream provider
post
Download raw vendor products JSON from Nexus
get
Vouchers
Create bulk vouchers
post
Authorise voucher (POS)
post
Confirm voucher (POS)
post
Reverse voucher (POS)
post
Get voucher by code
get
Get voucher by request UUID
get
Query vouchers
get
Query voucher alerts
get
Resolve voucher alert
post
Redeem a voucher into the customer vault
post
Create legacy-paid bulk vouchers
post
Campaign Ledger
Per-brand channel configuration and readiness flags
get
List campaigns with per-channel delivery breakdowns
get
Campaign delivery statistics with per-channel totals
get
Reserve PUSH/EMAIL recipients before publishing
post
Record accepted PUSH/EMAIL publishes against reservations
post
Report PUSH/EMAIL publish failures against reservations
post
Bulk-materialise in-app inbox messages for a campaign
post
Portal Auth
Request portal password reset OTP
post
Verify portal password reset OTP and set new password
post
Partner Webhooks
Get partner webhook dashboard state
get
Configure partner webhooks
post
RICA Limits
List RICA SIM limit increase requests
get
Get a RICA SIM limit request with SIM and spend evidence
get
Approve a RICA SIM limit increase request
patch
Reject a RICA SIM limit increase request
patch
Create a manual RICA SIM limit override
post
Revoke an active RICA SIM limit override
patch
Company Search
Search CIPC company details through Datanamix via Nexus
post
Person Search
Search consumer KYC details through Datanamix via Nexus
post
Operations - Innerbox
Find SIM boxes for an innerbox stock correction
get
Search eligible leaf partners for an innerbox reassignment
get
Reassign an eligible SIM box to an active leaf partner
post
Return an eligible SIM box to MVNO inventory
post
Operations - Warehouse Reclaim
List eSIM boxes cleanly extractable to the polaris warehouse
get
Transfer a whole clean eSIM or physical SIM box to the polaris warehouse
post
Porting
List port-in requests
get
Get port-in request detail
get
Retry a port-in request from the ops queue
post
List supported donor networks for port-in
get
List MTN port callback ledger events
get
List MTN port-out authorization requests
get
Get a port-out authorization request including its items and raw event
get
Approve a port-out authorization item
post
Reject a port-out authorization item
post
Retry the Nexus callback for a port-out authorization item
post
Backfill Polaris port-in callback routes
post
RICA Porting
Start a mobile number port-in request
post
Look up a public port-in status
post
Bulk RICA
List bulk RICA batches
get
Upload a bulk RICA CSV
post
Download the bulk RICA CSV template (header row)
get
Get a bulk RICA batch with counters
get
List rows of a bulk RICA batch
get
Process a validated bulk RICA batch
post
Wallet Ownership Operations
List wallet ownership operational reviews
get
Get a wallet ownership review and audit history
get
Refresh provider evidence and recommendation
post
Approve the current provider finding
post
Recheck and atomically apply an approved review
post
SMS
Send an SMS through Nexus for Beam delivery
post
Bulk-record campaign SMS deliveries accepted by Nexus
post
Reserve campaign recipients before publishing to Nexus
post
Mark reserved campaign recipients as failed to publish
post
List operator campaigns submitted through Nova
get
Get operator campaign delivery statistics from Nova
get
Voucher Admin
Reconcile confirmed vouchers missing sale transactions
post
Custom Links
Public custom-link icon proxy
get
List custom links
get
Create a custom link
post
Upload custom-link icon
post
Get custom link by UUID
get
Update custom link
patch
Delete custom link
del
Stores
List stores (admin)
get
Upsert store (admin)
put
Pulse Funding
List rewards-data products available to suppliers
get
Get the active supplier Pulse balance
get
List the active supplier funding requests
get
Create a supplier rewards-data funding request
post
Get an active supplier funding request
get
Loyalty Memberships
List loyalty memberships
get
Update a loyalty member program assignment
post
Loyalty Transactions
List loyalty transaction processing outcomes
get
Finance Recurring Fees
List products available for recurring fees
get
List partner recurring fees for admin review
get
Create a partner recurring fee
post
Update a partner recurring fee
patch
List partner recurring fees
get
Online Orders
List online orders (paginated)
get
List Shopify webhook events (paginated)
get
Re-process a failed/ops-queue webhook event (ops replay)
post
Get an online order with its units
get
Resolve an eSIM order RICA token (public, single-purpose)
get
Resend an eSIM QR-code email for an order unit
post
Shopify Admin
List Shopify product mappings (paginated)
get
Map a Shopify product to its fulfilment config (eSIM pool)
post
Update a Shopify product mapping
patch
IoT Auth
IoT portal login
post
Refresh IoT portal token
post
Logout IoT portal session
post
Current IoT portal session
get
Look up an IoT invitation
get
Accept an IoT invitation and set a password
post
IoT Platform
IoT workspace dashboard
get
/api/v1/iot/workspaces
get
/api/v1/iot/workspaces
post
/api/v1/iot/assets
get
/api/v1/iot/assets
post
/api/v1/iot/devices
get
/api/v1/iot/devices
post
/api/v1/iot/billing-accounts
get
/api/v1/iot/billing-accounts
post
/api/v1/iot/products
get
/api/v1/iot/rules
get
/api/v1/iot/rules
post
/api/v1/iot/reports
get
/api/v1/iot/users
get
/api/v1/iot/users
post
/api/v1/iot/audit-events
get
/api/v1/iot/rules/{ruleUuid}
patch
/api/v1/iot/rules/{ruleUuid}
del
/api/v1/iot/rules/{ruleUuid}/duplicate
post
/api/v1/iot/rules/{ruleUuid}/status
patch
/api/v1/iot/rules/{ruleUuid}/history
get
IoT User Access
/api/v1/iot/user-access/workspaces
get
/api/v1/iot/user-access/users
get
/api/v1/iot/user-access/users/{userUuid}
get
/api/v1/iot/user-access/matrix
get
/api/v1/iot/user-access/memberships
post
/api/v1/iot/user-access/memberships/{membershipUuid}
patch
/api/v1/iot/user-access/memberships/{membershipUuid}
del
/api/v1/iot/user-access/invitations
post
/api/v1/iot/user-access/invitations/{userUuid}/resend
post
IoT Admin
List all IoT partners and client workspaces
get
Create an IoT partner or client workspace
post
List all IoT users
get
Create an IoT workspace user
post
Create an IoT billing pool
post
List IoT top-up products
get
Create an IoT rule template
post
List current and revoked IoT platform administrators
get
Grant IoT platform access and invite users who have not completed onboarding
post
Edit an IoT platform administrator or revoke platform access
patch
Resend a pending IoT platform administrator invitation
post
IoT Dashboard
Get the IoT platform administration dashboard
get
Get operational statistics for an IoT workspace
get
IoT Funding
Get exact IoT workspace operational and finance capabilities
get
Start provider-hosted IoT card enrollment
post
List active IoT-owned verified payment methods
get
Get an owned hosted enrollment session status
get
Start an Ozow payment for an IoT funding facility
post
Charge an IoT-owned verified card to fund a facility
post
Get an exact IoT funding transaction status
get
Get the selected IoT client funding position
get
List immutable IoT funding journals
get
List immutable imported IoT service history
get
IoT Finance Admin
Confirm a reconciled EFT deposit
post
Confirm a reconciled Xero settlement
post
Execute and post an exact full provider refund
post
Post a reasoned IoT funding adjustment
post
Reverse an immutable IoT funding journal
post
Reconcile an IoT funding projection and ledger
post
Get a redacted IoT migration reconciliation report
get
IoT Operations
List SIMs and their billing relationships
get
/api/v1/iot/sims/{simUuid}
get
Set or clear a customer-facing SIM alias
patch
Assign or clear a SIM connected asset
patch
Move one SIM between Totogi-backed billing pools with verification
post
Get a SIM billing-pool move operation
get
List billing pools with complete service balances
get
/api/v1/iot/billing-pools/{poolUuid}
get
Refresh non-monetary Totogi balances for a billing pool
post
/api/v1/iot/billing-pools/{poolUuid}/sims
get
List optional connected-asset SIM groupings
get
Create a connected asset for grouping SIMs
post
/api/v1/iot/connected-assets/{assetUuid}
get
Update a connected asset
patch
/api/v1/iot/workspace-search
get
List provider service balances with billing-pool identity
get
IoT Top-ups
List recent IoT billing-pool top-ups
get
Purchase a product for an IoT billing pool
post
Bulk SMS
Get the current partner Bulk SMS account summary
get
List the current partner Bulk SMS templates
get
Create a Bulk SMS template
post
Send an immediate Bulk SMS campaign
post
Internal LMS
Internal LMS compatibility login
post
Review Profiles
Provision a normal review profile
post
Xero Health
Get central Xero token and tenant health
get
Refresh central Xero tokens and verify tenants
post
Totogi Management
List active Totogi plans from Nexus
get
Cancel a Totogi plan subscription with managed balances
post
Delete an eligible Totogi balance
del
Decrease an eligible Totogi balance
post
Delete a fetched Totogi device
del
Delete a fetched Totogi account
del
Contacts
List MVNO contacts
get
Create an MVNO contact
post
Get an MVNO contact
get
Update an MVNO contact
patch
Soft-delete an MVNO contact
del
List partner contacts
get
Create a partner contact
post
Get a partner contact
get
Update a partner contact
patch
Soft-delete a partner contact
del
Developers
3DS Callbacks
3DS ACS TermURL callback (public, no JWT)
post
3DS return URL fallback (public, no JWT)
get
Get the wallet top-up 3DS client state
get
Submit CVV and complete a wallet top-up 3DS payment
post
Cancel an awaiting wallet top-up 3DS challenge
post
API Keys
List API keys visible to the caller
get
Create a new API key
post
Get a single API key
get
Update an API key (name, expiry, and/or source allowlist)
patch
Revoke an API key
del
Universal Links
List universal links for the caller (public, context-aware)
get
Create a universal link
post
List all universal links with filters (admin, paginated)
get
Get universal link by UUID
get
Update a universal link
patch
Delete a universal link
del
Webhooks
Receive a Polaris-routed Sumsub verification event
post
Receive SIM activation status event from MTN via Pub/Sub push
post
Resume purchase from payment webhook
post
Ozow server-to-server payment notification
post
Receive transaction.completed events for Loyalty processing
post
Receive top-up transaction completion events
post
Receive transaction.completed events
post
Receive MTN status-confirmation from Polaris via Pub/Sub push
post
Receive reward processor events
post
Receive subscription.activated events
post
Receive subscription.cancelled events
post
Shopify order webhook (HMAC-signed, public, multi-store)
post
Receive MTN port authorization callback via Pub/Sub push
post
Receive MTN port workflow notification via Pub/Sub push
post
Receive Totogi events from Pub/Sub
post
Receive Silicon bulk/S3 wallet batch status callbacks
post
Continue deferred purchase fulfilment
post
Receive Beam SMS delivery status events
post
Capture Pulse dead-letter messages
post
Receive Crave membership updates
post
Reconcile loyalty messaging after reward allocation
post
Receive accepted loyalty SMS delivery receipts
post
Powered by
••••••db49
Endpoint
Method
Status
User Agent
