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, showing dedicated virtual accounts) on approval.
Requires an API key with admin permission. If the business has never registered, onboardingRequestId and status come back null.

Review status codes

reviewStatus is present only after SUBMIT. 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.

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 will be rejected with a 403 Forbidden response; an unrecognised, malformed or revoked key returns 401 Unauthorized. Manage your keys and their permissions under Developer → API keys in the dashboard.

Headers

x-api-version
string

API version in ISO 8601 format (e.g. 2025-12-28). Defaults to latest stable.

Response

Current SME registration status.

data
object