Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.kwugwo.africa/llms.txt

Use this file to discover all available pages before exploring further.

Every resource exposed by the API has an ID with the shape: 
<prefix>.<workspace>.<unique>
For example: ugw.VCvr.7K2qPmRtV9xLnQ8sD1cYwHfE.
  • <prefix> — three letters identifying the resource type.
  • <workspace> — a 4-character segment derived from the workspace (your nzube). It makes IDs easier to scan in logs, but it is not unique on its own — different workspaces can share the same 4-character segment, especially as the platform grows. Always use the full ID when looking a resource up; don’t treat the workspace segment as an identifier.
  • <unique> — a 24-character random identifier. This is what actually makes the ID unique across the entire platform.

​
Prefix reference

PrefixResourceFormat regex
ugwUgwo (payment request)ugw\.[a-zA-Z0-9]{4}\.[a-zA-Z0-9]{24}
actActivity (on an ugwo)act\.[a-zA-Z0-9]{4}\.[a-zA-Z0-9]{24}
onyOnye (customer)ony\.[a-zA-Z0-9]{4}\.[a-zA-Z0-9]{24}
chkCheckoutchk\.[a-zA-Z0-9]{4}\.[a-zA-Z0-9]{24}
pspNzube PSP configurationpsp\.[a-zA-Z0-9]{4}\.[a-zA-Z0-9]{24}
evtWebhook event (the uid on the delivery envelope)evt\.[a-zA-Z0-9]{4}\.[a-zA-Z0-9]{24}

​
Sandbox suffix

Kwugwo runs a separate sandbox environment at sandbox-api.kwugwo.africa. Sandbox and live data are fully isolated — a sandbox ID is never resolvable against the live API and vice versa.
Coming soon — visual sandbox tag. We’re rolling out a convention where every sandbox ID ends in _t, e.g. ugw.VCvr.7K2qPmRtV9xLnQ8sD1cYwH_t, so you can tell at a glance whether you’re looking at a sandbox or live object in a log line, an email, or a support ticket. This is not enforced yet — until it ships, the environment a key targets is the source of truth. Live IDs will continue to look exactly as they do today.

​
Why this format

  • It’s grep-friendly in logs.
  • The prefix tells you what the ID is without consulting the database.
  • The unique segment is long enough that you can safely log the full ID; it is not a secret.