ONYX
Docs

Partner Platform

Build approved integrations on top of Onyx identity, communication, and connectivity capabilities.

Onyx Partner Platform is the approved partner layer for building with Onyx account, identity, communication, and connectivity capabilities.

It brings two partner surfaces together:

  • Connect SDK
  • Partner Connectivity

Connect SDK lets approved apps request scoped access to Onyx ID, trust assertions, communication permissions, app-linked conversations, and webhook events.

Partner Connectivity gives approved partners a path to offer embedded mobile connectivity experiences where supported.

These surfaces are connected by the same principles:

  • access is permissioned
  • user consent is visible
  • partner capabilities are scoped
  • sensitive account data stays protected
  • availability depends on approval, region, compliance, and product readiness

What Partners Can Build

Approved partners can use Onyx Partner Platform to support:

  • Sign in with Onyx
  • account-linked app access
  • scoped profile and handle access
  • limited trust and verification assertions
  • consented communication permissions
  • app-linked conversation threads
  • message delivery and webhook events
  • embedded connectivity experiences where supported

Not every capability is available to every partner.

Some capabilities require:

  • app review
  • domain verification
  • production approval
  • user consent
  • account trust requirements
  • regional availability
  • compliance review

Connect SDK

Connect SDK is the application integration layer for Onyx ID.

It supports:

  • login and authorization flows
  • scoped consent
  • capability checks
  • trust and verification assertions
  • communication permission checks
  • pre-send simulation
  • app-thread messaging
  • webhook delivery

Connect SDK does not give apps unrestricted identity access.

Apps only receive the scopes, assertions, and communication permissions approved through Onyx ID.

Partner Connectivity

Partner Connectivity is the embedded connectivity layer for approved partners.

It can support partner experiences such as:

  • plan catalogue display
  • package selection
  • connectivity order creation
  • service provisioning
  • activation guidance
  • usage visibility
  • support and recovery workflows

Partner Connectivity is not a generic resale marketplace.

Partner availability, package support, pricing, customer support boundaries, and launch approval depend on the partner agreement and supported regions.

Partner Responsibilities

Partners are responsible for the experience they build around Onyx capabilities.

Depending on the integration, partners may need to manage:

  • their own app experience
  • customer-facing copy
  • retail checkout
  • consent presentation
  • support intake
  • refund or credit policy where applicable
  • secure handling of partner-side tokens, webhooks, and logs

Onyx controls the account, identity, consent, trust, connectivity, and policy checks that belong to Onyx.

Privacy And Consent

Onyx Partner Platform is designed around scoped access and data minimization.

Partners should not receive:

  • unrestricted account access
  • identity documents
  • private verification evidence
  • private wallet material
  • unrelated payment history
  • unrelated communication history
  • private device or session state

Connected apps receive only approved scopes and assertions.

Connectivity partners receive only the information needed to support the approved service flow.

Before Production

Before a partner integration reaches production, Onyx can require:

  • app identity review
  • approved redirect URIs
  • verified domains
  • allowed origins
  • scoped permission review
  • webhook signing validation
  • delivery testing
  • catalogue approval where connectivity is used
  • support and escalation review
  • privacy and compliance review

Disabled or unavailable capabilities should return a clear controlled state instead of failing silently.