DOCUMENTATIONv2

GET

Administration overview

Get identity readiness overview

/api/v2/admin/overview

AUTHENTICATIONBearer token · admin:readAUTHORITATIVE OWNERidentity-serviceCONTRACT AUTHORITYGenerated Rust OpenAPISTATUSSource ready · production listed

PURPOSE + BUSINESS CONTEXT

Return aggregate-only account growth, activation, onboarding, and wallet-readiness posture across 52 weekly cohorts.

WHEN THIS CALL IS USEFUL

Use this restricted aggregate when an administrator needs a 52-week account-acquisition and readiness trend before drilling into separately authorized identity workflows.

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 identity readiness overview.
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 identity readiness overview 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 admin:read scope.EXAMPLEBearer hc_live_…

RESPONSES

Status and payload examples

200Aggregate-only account growth, activation, onboarding, and wallet-readiness posture across exactly 52 weekly cohorts.Read completed · JSON RESPONSE+

{
  "source": "identity-service",
  "scope": "GLOBAL",
  "metrics": {
    "total_accounts": 850,
    "registered_12_months": 104,
    "activated_12_months": 72,
    "wallet_ready_12_months": 61,
    "onboarded_12_months": 58
  },
  "weekly": [
    {
      "week": "2025-09-01",
      "registered": 2,
      "activated": 1,
      "wallet_ready": 1,
      "onboarded": 1
    }
  ]
}

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 subject, claim or credential version, issuer and reviewer authority, evidence commitment, decision, expiry, and revocation status.

401The bearer credential is missing, invalid, or expired.Authentication required · JSON RESPONSE+

{
  "code": "invalid_credential",
  "message": "The bearer credential is missing, invalid, or expired."
}

INTEGRATION DECISIONinvalid_credential

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 subject-scoped trust claims, evidence, credentials, reviews, decisions, presentations, and revocations.
ESCALATE WHEN: Escalate when subject binding, evidence minimization, issuer or reviewer authority, decision lineage, expiry, or revocation cannot be established.

403The principal lacks exact admin:read authority.Authority or policy denied · JSON RESPONSE+

{
  "code": "insufficient_scope",
  "message": "The principal lacks exact admin:read authority."
}

INTEGRATION DECISIONinsufficient_scope

CALLER ACTION: Verify the exact scope, tenant or workspace membership, owner boundary, step-up purpose, feature policy, and resource eligibility. Never broaden authority automatically.
RETRY SAFETY: Do not retry until the missing authority or policy condition has been deliberately resolved with least privilege.
STATE RECONCILIATION: Confirm the caller and resource resolve to the same authority boundary for subject-scoped trust claims, evidence, credentials, reviews, decisions, presentations, and revocations.
ESCALATE WHEN: Escalate when subject binding, evidence minimization, issuer or reviewer authority, decision lineage, expiry, or revocation cannot be established.

502Identity returned a structurally invalid aggregate projection.Dependency unavailable or outcome uncertain · JSON RESPONSE+

{
  "code": "invalid_identity_source",
  "message": "Identity returned a structurally invalid aggregate projection."
}

INTEGRATION DECISIONinvalid_identity_source

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 subject, claim or credential version, issuer and reviewer authority, evidence commitment, decision, expiry, and revocation status.
ESCALATE WHEN: Escalate when subject binding, evidence minimization, issuer or reviewer authority, decision lineage, expiry, or revocation cannot be established.

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

{
  "code": "identity_unavailable",
  "message": "The authoritative Identity aggregate 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 subject, claim or credential version, issuer and reviewer authority, evidence commitment, decision, expiry, and revocation status.
ESCALATE WHEN: Escalate when subject binding, evidence minimization, issuer or reviewer authority, decision lineage, expiry, or revocation cannot be established.

OPERATIONAL NOTES

Security and lifecycle guarantees

Use this trend before drilling into separately authorized Identity workflows. It contains no account rows, names, email addresses, profile IDs, client IDs, wallet IDs, credentials, or mutation links.
weekly contains exactly 52 Monday-based buckets ordered oldest first. registered is the cohort denominator; activated, wallet_ready, and onboarded are independent subsets and must not be added together.
total_accounts is the current aggregate. The four *_12_months fields describe only the returned cohorts. Never infer an individual's state from this projection.
The gateway requires admin:read and calls Identity with a replay-protected signed request. Responses are no-store; re-fetch before reporting and never bypass the gateway for direct database access.

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 ↗