API Explorer

Tenant

Tenant

A Tenant is a customer of the operator of an OBP instance: an organisation that uses the instance. A Tenant belongs to no bank, and the Roles that manage Tenants are system Roles: CanCreateTenant, CanGetTenant, CanUpdateTenant and CanDeleteTenant.

A Tenant has a tenant_id, which is unique, cannot change, and is 2 to 64 URL-safe characters. It also has a name, a status (active, suspended or archived), a visibility (public, unlisted or private), and optionally a website and a logo.

Tenants were called Organisations until November 2026. The migration renameOrganisationsToTenants copied the Organisations and moved their Roles.

This is not the same as the tenancy model of a deployment, which is about how separate installations are run for different customers. See here.

Endpoints