Repo-owned docs, inside the Onyx web surface.

A calm, versioned documentation layer that lives in the app-owned website rather than a separate publishing shell.

Technical Docs

Docs/Onyx Connect SDK

Onyx Connect

How Onyx Connect lets trusted apps request scoped access to an Onyx ID.

Onyx Connect

Onyx Connect is the application integration and authorization layer for Onyx ID.

Onyx ID owns the user's identity, trust, profile projection, and consent model. Onyx Connect lets approved apps request scoped access to that model without receiving unrestricted identity data.

Status

Onyx Connect is in design-partner preview. Approved partners can build against the current integration surface while broader availability remains gated.

To get access, apply for a design-partner key.

How it works

Add Onyx Connect to your sign-in or account-linking flow. The user reviews what your app is asking for, connects their Onyx ID, and can revoke access later from Onyx ID settings.

Requestable access

| Access | What it means | |---|---| | Profile projection | Display name, avatar, handle, and other profile fields the user allows. | | Handle access | The Onyx handle needed to identify the user in your app. | | Trust context | A safe trust-state summary, when the app is allowed to see it. | | Communication reach | Permission to contact the user through approved Onyx communication surfaces. | | Community access | Linked community context where the user and policy allow it. | | Verification assertions | Scoped answers such as identity verified, age verified, jurisdiction eligible, organization verified, or payment eligible. |

Request only what your app needs. Access that is not requested, granted, or still valid is not transmitted.

What your app does and does not receive

Your app receives only explicit, scoped, permissioned, revocable access.
Your app never receives unrestricted identity access.
Your app does not receive raw regulated-verification payloads, provider data, private wallet details, internal user IDs, or private session/device state.
Access granted to your app is not shared with other apps.
The user can review and revoke access from Onyx ID settings as the permission center matures.