Skip to content

Get Current Tenant

Returns identity and account details for the tenant that owns the API key used to authenticate the request. Useful for a third-party app that already has an API key (e.g. issued via POST /v1/register or by an admin) and needs to resolve the tenant.id UUID — for example, to link an existing API account in a frontend without re-entering the RUC or P12 certificate, or to match incoming webhook deliveries back to the right account.

GET /v1/tenants/me

Authentication

Authorization: Bearer <api-key>

Response

json
{
  "ok": true,
  "tenant": {
    "id": "00000000-0000-0000-0000-000000000042",
    "email": "[email protected]",
    "subscriptionTier": "GROWTH",
    "status": "ACTIVE",
    "documentCount": 128,
    "documentQuota": 1000,
    "sandbox": false,
    "agreementAcceptedAt": "2026-06-28T12:00:00.000Z",
    "agreementVersion": "2026-06-28"
  }
}
FieldDescription
idTenant UUID. Use this to correlate webhook deliveries and other tenant-scoped resources.
emailTenant's registered email address.
subscriptionTierFREE, STARTER, GROWTH, or BUSINESS.
statusPENDING_VERIFICATION, ACTIVE, or SUSPENDED.
documentCountDocuments issued in the current billing period.
documentQuotaDocument limit for the current subscriptionTier.
sandboxtrue if the tenant is in the SRI test environment, false if promoted to production.
agreementAcceptedAtTimestamp of the most recent agreement acceptance event, or null for admin-created tenants. Compare against GET /v1/tenants/agreements to detect drift.
agreementVersionThe TERMS document version the tenant last accepted, or null for admin-created tenants.

Errors

StatusCodeWhen
401UNAUTHORIZEDMissing or invalid API key
429TOO_MANY_REQUESTSRate limit exceeded

Notes

  • No X-Issuer-Id header is required — this endpoint resolves the tenant, not an issuer.
  • The response reflects exactly what the authenticate middleware already resolved from the API key — there is no separate database lookup, so any active key (sandbox or production) returns its tenant's current state.
  • This does not return the list of issuers (branches) — use GET /v1/issuers for that.
  • Unlike most authenticated endpoints, this one stays reachable even when status is SUSPENDED — it's one of a small set of read-only endpoints a suspended tenant can still use (see the ACCOUNT_SUSPENDED entry in the error catalogue). Polling this endpoint is a valid way to detect a suspension and check the account's current status.
  • This is also how you find out a paid-tier upgrade completed. After requesting a tier at promotion and submitting payment proof, you'll get a notification and email the moment your provider records a decision, but final activation (once SRI authorizes the self-billed invoice) still has no notification of its own — poll this endpoint periodically; subscriptionTier and documentQuota update the moment the subscription activates. For the in-between states (pending, rejected, why) see GET /v1/subscriptions/me instead — this endpoint only shows the end result.

Comprobify API Documentation