Skip to main content
GET
Get SME registration status
Returns the most recent SME registration state for the authenticated business. Once submitted, the response also includes the latest review outcome so you can gate downstream flows (for example, issuing dedicated KES virtual accounts) on approval.
Only relevant if you are pursuing dedicated KES virtual accounts via Register SME. Other corridors do not use this flow. Requires an API key with admin permission. If the business has never registered, onboardingRequestId and status come back null.

Review outcomes

reviewStatus is present only after SUBMIT. Dedicated KES virtual accounts under your entity are issued only after APPROVED. When the review is REJECTED, rejectReasons[] carries human-readable reasons you can surface to the operator.
The set of reviewStatus values may grow over time as new outcomes are surfaced. Existing values will not change meaning; handle unfamiliar values by falling back to UNKNOWN.

Freshness

The response may also include isReviewStatusStale: true. That flag means Afriex could not reach the review provider on this read, so the reviewStatus reflects the last known value (or UNKNOWN if none is cached) rather than the current one. Poll again later for a fresh read; the field is absent when the read succeeded.

Authorizations

x-api-key
string
header
required

Static business API key issued from the dashboard. A business can provision multiple API keys, each scoped to a configurable set of permissions (e.g. read transactions, create deposits, etc). Permissions are chosen per key at creation time in the dashboard and may be revoked by deleting the key. Requests made with a key that does not include the permission required by the target endpoint is rejected with a 401 Unauthorized response, the same response an unrecognised, malformed or revoked key returns. The API does not distinguish the two cases on the wire. Manage your keys and their permissions under Developer → API keys in the dashboard.

Headers

x-api-version
string

API version in ISO 8601 format. The only supported version is 2026-05-18, which is also the default when the header is omitted. Any other value is rejected with a 400 Bad Request.

Response

Current SME registration status.

data
object