Retrieve tenant

GET

tenants

curl https://api.zquence.ai/v1/tenants/me \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

{
  "tenantId": "bc41c6ab-7206-4033-b632-4d1cfa86d840",
  "name": "Acme Escrow",
  "loginSlug": "acme-escrow",
  "environment": "live",
  "status": "active",
  "branding": {
    "logoKey": "tenants/bc41c6ab-7206-4033-b632-4d1cfa86d840/logo.png",
    "theme": {
      "primaryColor": "#0070FA",
      "secondaryColor": "#4D9DFF",
      "textColor": "#0F172A",
      "backgroundColor": "#FFFFFF",
      "cardBackgroundColor": "#F8FAFC",
      "primaryTextColor": "#FFFFFF",
      "secondaryTextColor": "#64748B"
    }
  },
  "planId": "6a1ea31b892791af056f46bd",
  "plan": {
    "id": "6a1ea31b892791af056f46bd",
    "name": "Growth",
    "currency": "usd",
    "monthlyPrice": 99,
    "annualPrice": 990,
    "durationDays": 30,
    "transactionLimit": 500,
    "usersLimit": 1000,
    "apiCallsPerMonth": 50000
  },
  "subscriptionStatus": "active",
  "subscriptionStart": "2026-01-01T00:00:00.000Z",
  "subscriptionEnd": "2027-01-01T00:00:00.000Z",
  "apiCallsPerMonthLimit": 50000,
  "environmentsLimit": 3
}

{
  "tenantId": "bc41c6ab-7206-4033-b632-4d1cfa86d840",
  "name": "Acme Escrow",
  "loginSlug": null,
  "environment": "sandbox",
  "status": "active",
  "branding": {},
  "plan": null,
  "subscriptionStatus": undefined,
  "subscriptionStart": undefined,
  "subscriptionEnd": undefined
}

{
  "statusCode": 401,
  "message": "Unauthorized"
}

{
  "statusCode": 404,
  "message": "Tenant not found"
}

Returns the full profile for the tenant associated with the authenticated API key. Includes branding configuration, subscription plan limits, and environment constraints.

Returns

string

Unique tenant identifier (UUID format, e.g. bc41c6ab-7206-4033-b632-4d1cfa86d840).

string

Display name of the tenant (e.g. "Acme Escrow").

URL-safe login slug used for the tenant’s branded login page (e.g. "acme-escrow"). null if not configured.

string

Primary environment mode — "live" or "sandbox".

string

Tenant account status. One of "active", "inactive", "disabled", "deleted".

object

Branding configuration for the tenant’s hosted pages.

Show branding fields

string | undefined

S3 key for the tenant’s logo file. Use the logo URL endpoint to get a presigned view URL.

object | undefined

Color theme overrides. All fields are optional hex color strings.

Show theme fields

string | undefined

Hex color for primary buttons and accents.

string | undefined

Hex color for secondary elements.

string | undefined

Default text color.

string | undefined

Page background color.

string | undefined

Card/panel background color.

string | undefined

Text color on primary-colored elements.

string | undefined

Text color on secondary-colored elements.

string | undefined

MongoDB ObjectId of the assigned plan. undefined if no plan is assigned.

object | null

Summary of the assigned plan. null if no plan is assigned.

Show plan fields

string

Plan ID.

string

Plan display name (e.g. "Growth", "Enterprise").

string

Billing currency in lowercase ISO 4217 (e.g. "usd").

number

Monthly price in major units (e.g. 99 for $99/month).

number

Annual price in major units.

number

Plan duration in days. 0 means no fixed duration.

number

Maximum number of accounts/transactions allowed. 0 means unlimited.

number

Maximum number of users/customers allowed. 0 means unlimited.

number

Monthly API call allowance. 0 means unlimited.

string | undefined

Current subscription state — "pending", "active", or "expired". undefined if no subscription is active.

string | undefined

ISO 8601 UTC timestamp when the subscription started. undefined if not set.

string | undefined

ISO 8601 UTC timestamp when the subscription expires. undefined if not set.

number | undefined

Per-tenant override for the monthly API call limit. When set, this takes precedence over the plan’s apiCallsPerMonth. undefined means the plan limit applies.

number | undefined

Maximum number of sandbox environments this tenant can create. undefined means no limit beyond the platform default.

Error codes

Status	Meaning
`400`	`tenantId` could not be resolved from the authenticated credential.
`401`	Missing or invalid API key pair.
`404`	The tenant associated with the authenticated credential no longer exists.

curl https://api.zquence.ai/v1/tenants/me \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

{
  "tenantId": "bc41c6ab-7206-4033-b632-4d1cfa86d840",
  "name": "Acme Escrow",
  "loginSlug": "acme-escrow",
  "environment": "live",
  "status": "active",
  "branding": {
    "logoKey": "tenants/bc41c6ab-7206-4033-b632-4d1cfa86d840/logo.png",
    "theme": {
      "primaryColor": "#0070FA",
      "secondaryColor": "#4D9DFF",
      "textColor": "#0F172A",
      "backgroundColor": "#FFFFFF",
      "cardBackgroundColor": "#F8FAFC",
      "primaryTextColor": "#FFFFFF",
      "secondaryTextColor": "#64748B"
    }
  },
  "planId": "6a1ea31b892791af056f46bd",
  "plan": {
    "id": "6a1ea31b892791af056f46bd",
    "name": "Growth",
    "currency": "usd",
    "monthlyPrice": 99,
    "annualPrice": 990,
    "durationDays": 30,
    "transactionLimit": 500,
    "usersLimit": 1000,
    "apiCallsPerMonth": 50000
  },
  "subscriptionStatus": "active",
  "subscriptionStart": "2026-01-01T00:00:00.000Z",
  "subscriptionEnd": "2027-01-01T00:00:00.000Z",
  "apiCallsPerMonthLimit": 50000,
  "environmentsLimit": 3
}

{
  "tenantId": "bc41c6ab-7206-4033-b632-4d1cfa86d840",
  "name": "Acme Escrow",
  "loginSlug": null,
  "environment": "sandbox",
  "status": "active",
  "branding": {},
  "plan": null,
  "subscriptionStatus": undefined,
  "subscriptionStart": undefined,
  "subscriptionEnd": undefined
}

{
  "statusCode": 401,
  "message": "Unauthorized"
}

{
  "statusCode": 404,
  "message": "Tenant not found"
}

curl https://api.zquence.ai/v1/tenants/me \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

{
  "tenantId": "bc41c6ab-7206-4033-b632-4d1cfa86d840",
  "name": "Acme Escrow",
  "loginSlug": "acme-escrow",
  "environment": "live",
  "status": "active",
  "branding": {
    "logoKey": "tenants/bc41c6ab-7206-4033-b632-4d1cfa86d840/logo.png",
    "theme": {
      "primaryColor": "#0070FA",
      "secondaryColor": "#4D9DFF",
      "textColor": "#0F172A",
      "backgroundColor": "#FFFFFF",
      "cardBackgroundColor": "#F8FAFC",
      "primaryTextColor": "#FFFFFF",
      "secondaryTextColor": "#64748B"
    }
  },
  "planId": "6a1ea31b892791af056f46bd",
  "plan": {
    "id": "6a1ea31b892791af056f46bd",
    "name": "Growth",
    "currency": "usd",
    "monthlyPrice": 99,
    "annualPrice": 990,
    "durationDays": 30,
    "transactionLimit": 500,
    "usersLimit": 1000,
    "apiCallsPerMonth": 50000
  },
  "subscriptionStatus": "active",
  "subscriptionStart": "2026-01-01T00:00:00.000Z",
  "subscriptionEnd": "2027-01-01T00:00:00.000Z",
  "apiCallsPerMonthLimit": 50000,
  "environmentsLimit": 3
}

{
  "tenantId": "bc41c6ab-7206-4033-b632-4d1cfa86d840",
  "name": "Acme Escrow",
  "loginSlug": null,
  "environment": "sandbox",
  "status": "active",
  "branding": {},
  "plan": null,
  "subscriptionStatus": undefined,
  "subscriptionStart": undefined,
  "subscriptionEnd": undefined
}

{
  "statusCode": 401,
  "message": "Unauthorized"
}

{
  "statusCode": 404,
  "message": "Tenant not found"
}

Introduction

Tenant

Environments

Customers

Accounts

KYC

Document reviews

Source of funds

Files

Webhooks

Sync

Sanctions

Retrieve tenant

Returns

Error codes

​Returns

​Error codes

Returns

Error codes