live · mainnetoc · docs
specs · api · guides
docs / documentation

@orangecheck/auth-client


@orangecheck/auth-client / DisplayIdentity

Interface: DisplayIdentity

Defined in: types.ts:21

The identity a user has chosen to show in their account badge — the collapsed label every family site renders instead of the raw did:oc. Carried as a JWT claim by the auth host, so the choice is consistent across every .ochk.io subdomain with no round-trip.

kind is which identity; value is the full, renderable value (the did:oc, the Bitcoin address, the email, or the npub). Integrators rendering their own chip read useOcSession().account.displayIdentity — it is always populated (it defaults to the did).

Properties

PropertyTypeDefined in
<a id="property-kind"></a> kind"email" | "btc" | "did" | "nostr"types.ts:22
<a id="property-value"></a> valuestringtypes.ts:23