DOCUMENTATIONv2

GET

User Profile Data

Get tenant brand

/api/v2/tenant-brand

AUTHENTICATIONBearer token · profile:readAUTHORITATIVE OWNERidentity-service · tenant-configurationCONTRACT AUTHORITYGenerated Rust OpenAPISTATUSSource ready · production listed

PURPOSE + BUSINESS CONTEXT

Return the authenticated tenant's presentation-safe names, theme, assets, links, and labels without exposing policy, credential, banking, registration, or infrastructure configuration.

WHEN THIS CALL IS USEFUL

Load after authentication when an application needs tenant-specific public names, mode behavior, assets, links, and vocabulary.

OUTCOME · Discover

What changes

Read-only projection; it grants no mutation, settlement, traffic, or authority change.

WHY IT MATTERS

Gives people and agents a contract-backed way to discover tenant brand.
Separates subject identity, consent, evidence, provider output, review, issuer credentials, and relying-party acceptance instead of collapsing them into a universal trust score.

ISOLATION + AUTHORITY

Bearer subject, tenant, purpose, policy version, role, issuer, reviewer, provider, and relying-party boundaries remain distinct. The response or transition grants no payment, custody, settlement, publisher, matching, or trading authority and must not expose regulated evidence beyond the live schema.

BEFORE YOU CALL

Authenticate at the documented boundary: bearer+scope.
Use the live OpenAPI schema as the authority for the exact request shape and response model.
Resolve the applicable purpose, policy version, consent or role basis, and required assurance before relying on this result.

WHAT TO DO NEXT

Select one canonical identifier from the response and open its detail operation when the live contract exposes one.
Use the returned lifecycle state and policy version to choose the next least-privilege trust action; do not infer a missing stage.

AGENT GUIDANCE

Use tenant brand only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Use the live OpenAPI schema as the authority for the exact request shape and response model.
Treat policy availability, consent, evidence capture, completed checks, review, decision, credential issuance, validity, and relying-party acceptance as separate facts.
Use response links and canonical identifiers instead of constructing internal service URLs or scraping the website.

MACHINE CONTRACT

The exact deployed parameters, schemas, responses, security requirements, and Hybrid-Chain agent metadata are authoritative at this operation's production OpenAPI JSON Pointer. The readable tables below add integration guidance; the deployed OpenAPI controls if guidance and the machine contract ever differ.

Open the authoritative production contract ↗

EXTENDED INTEGRATION GUIDANCE

Readable request and response reference

Examples illustrate integration intent; the referenced OpenAPI operation and component schemas define the executable shape.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE

AuthorizationheaderRequired

Bearer tokenCredential containing the profile:read scope.EXAMPLEBearer hc_live_…

RESPONSES

Status and payload examples

200Presentation-safe brand derived from the authenticated tenant.Read completed · JSON RESPONSE+

{
  "tenant_uuid": "global",
  "brand_id": "brand-42",
  "name": "Hybrid-Chain",
  "symbol": "HYB",
  "description": "Composable infrastructure for digital business.",
  "theme": {
    "default_mode": "dark",
    "allow_mode_switching": true,
    "style": "terminal",
    "custom_css_url": null
  },
  "assets": {
    "logo_light_url": "https://assets.hybrid-chain.com/logo-light.svg",
    "logo_dark_url": "https://assets.hybrid-chain.com/logo-dark.svg",
    "logo_light_square_url": null,
    "logo_dark_square_url": null,
    "favicon_url": "https://assets.hybrid-chain.com/favicon.svg",
    "background_light_url": null,
    "background_dark_url": null
  },
  "links": {
    "website_url": "https://hybrid-chain.com",
    "portal_url": "https://hybrid-chain.com/account",
    "terms_url": "https://hybrid-chain.com/terms",
    "api_docs_url": "https://hybrid-chain.com/api-reference/v2"
  },
  "labels": {
    "landing_page": "Home",
    "chain": "Chain",
    "marketplace": "Marketplace",
    "trading": "Trading",
    "nft_item": "Asset",
    "vault": "Vault"
  }
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then select one canonical identifier from the response and open its detail operation when the live contract exposes one.
RETRY SAFETY: Repeat only when the integration needs a fresher authoritative projection.
STATE RECONCILIATION: Use returned identifiers and versions as the comparison point for later reads. Refresh the specific profile or account projection and compare tenant, profile, lifecycle, and version identifiers before retrying.

401The bearer credential is invalid.Authentication required · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "The bearer credential is invalid."
}

INTEGRATION DECISIONinvalid_credentials

CALLER ACTION: Discard the rejected credential, complete the documented authentication or reassertion flow, and rebuild any request signature with fresh timestamps and nonces.
RETRY SAFETY: Retry only with a newly valid credential and fresh replay-protection values. Do not replay an expired signature.
STATE RECONCILIATION: Authentication failed before an authoritative read was returned for the authenticated profile, tenant brand, referral, funding, and account-lifecycle projections.
ESCALATE WHEN: Escalate when a fresh session resolves to an unexpected tenant or profile, or when an account lifecycle receipt cannot be found after reconciliation.

404No active brand is assigned to the tenant.Resource not visible · JSON RESPONSE+

{
  "code": "brand_not_found",
  "message": "No active brand is assigned to the tenant."
}

INTEGRATION DECISIONbrand_not_found

CALLER ACTION: Verify the canonical identifier and authenticated owner boundary. A 404 may intentionally conceal a resource outside the caller's authority.
RETRY SAFETY: Do not retry the unchanged identifier repeatedly. Refresh the relevant collection or lookup before choosing another identifier.
STATE RECONCILIATION: Refresh the specific profile or account projection and compare tenant, profile, lifecycle, and version identifiers before retrying.
ESCALATE WHEN: Escalate when a fresh session resolves to an unexpected tenant or profile, or when an account lifecycle receipt cannot be found after reconciliation.

503Identity is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+

{
  "code": "identity_unavailable",
  "message": "Identity is unavailable."
}

INTEGRATION DECISIONidentity_unavailable

CALLER ACTION: Treat the failure as transient and preserve the last known good representation without presenting it as fresh.
RETRY SAFETY: Retry with bounded exponential backoff and jitter; stop after the integration's failure budget is exhausted.
STATE RECONCILIATION: Refresh the specific profile or account projection and compare tenant, profile, lifecycle, and version identifiers before retrying.
ESCALATE WHEN: Escalate when a fresh session resolves to an unexpected tenant or profile, or when an account lifecycle receipt cannot be found after reconciliation.

OPERATIONAL NOTES

Security and lifecycle guarantees

The tenant boundary comes only from the authenticated principal; there is no tenant selector.
This projection excludes registration policy, provider credentials, bank configuration, storage secrets, and infrastructure settings.
Asset and link URLs are presentation values. They do not authorize navigation, retrieval, or a business action.

UPGRADING FROM V1

Legacy calls replaced by this operation

If you maintain an older integration, use this map to find the V2 replacement. Do not translate the old request field-for-field: rebuild it from the V2 parameters and schemas above because identity, authorization, replay protection, and response semantics may have changed.

GET/api/v1/profile/whitelabelPROFILE: Get Profile Whitelabel Data

DOCUMENTATION STATUS

This route is implemented in canonical gateway source and appears in the production OpenAPI snapshot observed 2026-09-11T06:35:11.572Z. Authentication, tenant, feature, venue, and market policy still apply.

Verify the exact production OpenAPI operation ↗Return to the V2 directory ↗