Skip to content
StraventaDocs
Now in Sandbox.

Read a tenant's identity + commercial fields

GET
/v1/admin/tenants/{tenantId}

Returns the tenant's identity and commercial fields (status, commercial_class, kyc_status, name, slug, branding) for a service-token caller. This is the API the money plane reads instead of querying identity.tenants directly (D2 fence). Gated on platform.tenant.read.

Authorization

bearerAuth
AuthorizationBearer <token>

JWT Bearer access token. Clock skew tolerance is ±60 seconds.

In: header

Path Parameters

tenantId*string

Tenant identifier.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

curl https://sandbox.505pay.link/v1/admin/tenants/{tenantId} \  -H "Authorization: Bearer $TOKEN"
{
  "id": "018f1a2b-0001-7000-8000-000000000099",
  "name": "Acme Corp",
  "slug": "acme-corp",
  "status": "active",
  "commercial_class": "subscriber",
  "kyc_status": "approved",
  "is_platform": false,
  "env": "production",
  "parent_tenant_id": "018f1a2b-0000-7000-8000-000000000001",
  "branding": {
    "primary_color": "#0B5CE4"
  }
}
{
  "error": "unauthenticated",
  "message": "missing or invalid bearer token",
  "request_id": "req_01abc123"
}
{
  "error": "password_rotation_required",
  "message": "Your password has expired under the tenant policy. Rotate it to continue.",
  "request_id": "req_01abc130"
}
{
  "error": "not_found",
  "message": "the requested resource was not found",
  "request_id": "req_01abc125"
}
{
  "error": "rate_limited",
  "message": "too many requests",
  "request_id": "req_01abc127"
}

Was this page helpful?