Get Your Tenant Record via the Current Access Token

GET /v1/tenants/self — Returns your tenant record, including provisioned products, allowed domains, and key identifiers. Requires tenants.read scope.

This endpoint returns the tenant record associated with the access token used in the request. It is the primary way to introspect your own tenant configuration — including the products provisioned under your account, allowed domain origins, and key identifiers. It is particularly useful during integration setup to verify that your credentials are correctly scoped and that the expected products are visible.

​

Endpoint

GET /v1/tenants/self

Required scope: com.diameterpay.api/tenants.read

Authentication via INTERNAL_KEY is also accepted for server-side integrations that use a static API key instead of a scoped OAuth2 token.

​

Request Headers

Authorization · string · required

Bearer token or internal API key. Format: Bearer {access_token}

​

Response

Returns HTTP 200 OK with a TenantOutput object.

id · string

UUID uniquely identifying your tenant.

fullName · string

The full legal or display name of your organization as registered with Diameter.

shortName · string

A short, URL-safe identifier for your tenant, used in certain platform references.

products · array

List of products provisioned under your tenant. Each entry is a ProductOutput object containing id, fullName, connectedBanks, reconciliationInfo, createdAt, and updatedAt.

validDomains · array

List of allowed origin domains configured for your tenant. Requests from these domains are permitted by CORS policy.

createdAt · string

ISO 8601 timestamp of when your tenant was created.

updatedAt · string

ISO 8601 timestamp of the most recent update to your tenant record.

​

Example

cURL

curl --request GET \
  --url https://api.diameterpay.com/v1/tenants/self \
  --header "Authorization: Bearer {access_token}"

​

Response

{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "fullName": "Acme Payments Inc.",
  "shortName": "acme-payments",
  "products": [
    {
      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "fullName": "Domestic Wire Product",
      "connectedBanks": ["PORTAGE"],
      "reconciliationInfo": null,
      "createdAt": "2024-01-15T08:00:00.000Z",
      "updatedAt": "2024-01-15T08:00:00.000Z"
    }
  ],
  "validDomains": [
    "app.acmepayments.com",
    "dashboard.acmepayments.com"
  ],
  "createdAt": "2024-01-10T09:00:00.000Z",
  "updatedAt": "2024-05-20T16:45:00.000Z"
}