DOCUMENTATIONv2

GET

User intelligence and risk

Get identity control record

/api/v2/admin/users/{profile_uuid}

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

PURPOSE + BUSINESS CONTEXT

Return one identity's lifecycle, capability controls, alerts, evidence signals, sessions, and audit events.

WHEN THIS CALL IS USEFUL

Use after an authorized exact lookup when an investigator needs the subject's current control version, capability controls, alerts, deterministic evidence commitments, session posture, and retained intervention history.

OUTCOME · Inspect

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 inspect identity control record.
Combines minimized identity lookup with explainable operational risk posture without turning a score or alert into an automatic identity or enforcement decision.

ISOLATION + AUTHORITY

Tenant scope, identity, profile, lifecycle, deterministic signal, risk tier, reviewer rating, alert, evidence, investigation, policy decision, and enforcement authority remain distinct. Search results do not reveal secrets and cannot suspend, activate, close, transact for, or otherwise mutate an identity.

BEFORE YOU CALL

Authenticate at the documented boundary: bearer+scope.
Supply the required profile_uuid (path) exactly as defined by the live contract.
Use an exact tenant-scoped identity query where possible and resolve the policy purpose, reviewer authority, evidence freshness, and minimum necessary disclosure.

WHAT TO DO NEXT

Select an exact tenant-scoped identity and inspect the supporting alerts, evidence, rating, and lifecycle data before forming a conclusion.
Apply any restriction, remediation, or lifecycle change only through its separately authorized policy workflow; search is read-only.

AGENT GUIDANCE

Use identity control record only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Supply the required profile_uuid (path) exactly as defined by the live contract.
Distinguish a matching identifier, observed signal, computed tier, human rating, open alert, investigation finding, policy decision, and separately authorized lifecycle action.
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:identity:read scope.EXAMPLEBearer hc_live_…

profile_uuidpathRequired

canonical profile identifierExact tenant-visible profile returned by an authorized lookup.EXAMPLEprofile-01J…

RESPONSES

Status and payload examples

200One minimized identity control record with deterministic evidence commitments and hash-chained intervention history.Read completed · JSON RESPONSE+

{
  "identity": {
    "identity_uuid": "identity-01J…",
    "profile_uuid": "profile-01J…",
    "tenant_uuid": "tenant-01J…",
    "email": "[email protected]",
    "username": "person",
    "display_name": "Example Person",
    "identity_active": true
  },
  "control": {
    "lifecycle_status": "REVIEW_REQUIRED",
    "risk_score": 72,
    "risk_tier": "HIGH",
    "reviewer_rating": "WATCH",
    "review_reason": "Manual review pending.",
    "version": 4,
    "updated_by": "admin-01J…",
    "updated_at": "2026-09-01T18:00:00Z"
  },
  "capabilities": [
    {
      "capability": "LOGIN",
      "status": "ACTIVE",
      "reason": "",
      "version": 0
    },
    {
      "capability": "TRADING",
      "status": "ACTIVE",
      "reason": "",
      "version": 0
    }
  ],
  "alerts": [
    {
      "uuid": "alert-01J…",
      "rule_code": "AUTH_FAILURE_BURST",
      "severity": "HIGH",
      "status": "OPEN",
      "title": "Repeated authentication failures",
      "summary": "Retained security evidence requires review.",
      "occurrence_count": 6,
      "assigned_to": null,
      "acknowledged_by": null,
      "acknowledged_at": null,
      "resolved_by": null,
      "resolved_at": null,
      "resolution": null,
      "created_at": "2026-09-01T17:45:00Z",
      "updated_at": "2026-09-01T17:45:00Z"
    }
  ],
  "signals": [
    {
      "uuid": "signal-01J…",
      "signal_type": "AUTH_FAILURE_BURST",
      "source_service": "identity-security",
      "severity": "HIGH",
      "score_delta": 25,
      "summary": "Repeated authentication failures",
      "evidence_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "observed_at": "2026-09-01T17:45:00Z"
    }
  ],
  "events": [
    {
      "uuid": "event-01J…",
      "event_type": "RATING_CHANGED",
      "target_ref": "RISK_REVIEW",
      "actor_ref": "admin-01J…",
      "reason": "Manual review required.",
      "before": {
        "reviewer_rating": "UNRATED"
      },
      "after": {
        "reviewer_rating": "WATCH"
      },
      "previous_event_hash": null,
      "event_hash": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
      "created_at": "2026-09-01T18:00:00Z"
    }
  ],
  "session_posture": {
    "active_mobile_sessions": 1,
    "last_mobile_activity": "2026-09-01T18:01:00Z"
  }
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then select an exact tenant-scoped identity and inspect the supporting alerts, evidence, rating, and lifecycle data before forming a conclusion.
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 administrator bearer is missing, invalid, or expired.Authentication required · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "The administrator bearer is missing, invalid, or expired."
}

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 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 bearer lacks admin:identity:read, an eligible administrator role, or tenant authority.Authority or policy denied · JSON RESPONSE+

{
  "code": "risk_review_forbidden",
  "message": "The bearer lacks admin:identity:read, an eligible administrator role, or tenant authority."
}

INTEGRATION DECISIONrisk_review_forbidden

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.

404No visible tenant-bound control record exists for the exact profile.Resource not visible · JSON RESPONSE+

{
  "code": "managed_identity_not_found",
  "message": "No visible tenant-bound control record exists for the exact profile."
}

INTEGRATION DECISIONmanaged_identity_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 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.

422The identifier, cursor, limit, or exact state filter is invalid.Request must change · JSON RESPONSE+

{
  "code": "invalid_risk_query",
  "message": "The identifier, cursor, limit, or exact state filter is invalid."
}

INTEGRATION DECISIONinvalid_risk_query

CALLER ACTION: Rebuild the request from the live OpenAPI operation and correct the rejected method, media type, header, parameter, or body field.
RETRY SAFETY: Do not retry the same invalid request. A corrected read may be sent as a new attempt.
STATE RECONCILIATION: Compare the submitted values with the documented constraints before another call. 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 risk projection is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+

{
  "code": "identity_risk_unavailable",
  "message": "The authoritative Identity risk projection is unavailable."
}

INTEGRATION DECISIONidentity_risk_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

Read control.version before lifecycle or rating actions and the selected capability version before a capability action. On conflict, re-read rather than guessing a version.
signals contain summaries and SHA-256 evidence commitments, not raw KYC media, sanctions match data, credentials, passwords, tokens, or secret keys. A commitment supports later verification by an authorized custodian; it does not disclose the source evidence.
alerts are workflow records and events are attributed before/after evidence. Preserve nulls and uncertainty; do not promote either into a legal conclusion or unrelated business authority.
TRADING may be visible in capabilities for posture, but the intervention route rejects every TRADING capability change while the freeze is active.

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 ↗