Return the catalog of KYB levels available to this client.
Clients pick a key from this list when creating a business customer
with verification_mode=urbanpayx_kyb. The underlying KYB provider
is intentionally NOT surfaced — callers should treat each key as an
opaque identifier.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Returns the catalog of KYB verification levels available to your client. Each entry has a stable key and a human-readable display_name. You pass a key from this list when creating a business customer under UrbanpayX-managed KYB so UrbanpayX knows which level of business verification to run. The list is read-only and reflects only the levels currently enabled for your client.
Authentication & access
- Requires a client API token:
Authorization: Bearer <token>. - The caller must hold the
kyb.businesses.readpermission. - Allowed roles: OWNER, DEVELOPER, OPERATIONS.
Level keys
keyis an opaque, stable identifier you send and receive over the API (for example when configuring a business customer's KYB verification). Treat it as opaque — do not parse it or infer the verification backend from it.display_nameis a label safe to render verbatim in your own UI.- Only levels that are active and accessible to your client are returned. Levels can be globally available or scoped to specific clients; levels not assigned to your client are omitted entirely.
Response
200 — returns a KybLevelCatalogResponse:
| Field | Type | Description |
|---|---|---|
levels | array | The KYB levels available to your client, ordered by key. |
levels[].key | string | Stable identifier used in API calls. |
levels[].display_name | string | Human-readable label. |
The array may be empty if no KYB levels are enabled for your client.
Error responses
This endpoint returns no endpoint-specific error responses.
Standard 401 (authentication), 403 (insufficient permission or role), and 429 (rate limit) responses apply to every endpoint and are documented in the Error reference.