Integrate / Overview

Integrate with Yutai

The three ways a distributor connects to Yutai, and the kinds of distributor it serves, in one page. If this is your first integration, the Get started page walks the path to a first call: what to send, who approves it, and how the key reaches you once. Every state below is read when the site is built, from the zones the preview serves, the elements the SDK registers and the routes the site's API answers, so what you read is what Yutai serves today.

View as .md

Every state on this page is read when the site is built, never retyped by hand: when Yutai ships what a row reading Planned names, the page reads it the same day.

Ways to integrate

A distributor connects through one way or several: the hosted app, the embedded elements, or the distributor API. Each way carries its own state beside it.

The hosted holder appAvailable

Yutai serves the holder app itself: the holder opens it, sees their own credential, tier and benefits, and your site hosts no line of it.

Open Yutai app

The SDK's elementsAvailable

The SDK's elements render Yutai's own components inside your pages, styled with the tokens you set. The elements registered today are in the SDK; each names the docs page that explains it when one stands, and the docs still planned for the rest stand below.

yutai-credential-card: AvailableCredential card
yutai-tier-badge: AvailableTier badge
yutai-benefits-list: AvailableBenefits list
yutai-benefits-module: AvailableBenefits module

The distributor APICallable today

Your server asks the distributor API for the facts behind your screens, with a key the platform issues. Each call reads the state its route answers, and every path links its own call page, where the call's parameters, its answer and its errors stand.

GET /v1/eligibility: Callable today
GET /v1/availability: Callable today
GET /v1/registry/companies: Callable today
GET /v1/registry/instruments: Callable today
GET /v1/claims/{id}: Callable today
POST /v1/claims/{id}/link: Callable today
GET /v1/status: Callable today
POST /v1/claims/challenge: Callable today
POST /v1/claims: Callable today
GET /v1/fulfilments: Callable today
POST /v1/fulfilments/{id}/confirm: Callable today
POST /v1/connect/sessions: Callable today
GET /v1/connect/sessions/{id}: Callable today

The kinds of distributor

A distributor is one of three kinds. What Yutai reads, what the distributor sends, how long a holder has held and how a claim is proven differ by the kind. The three kinds, side by side:

The kinds of distributor
What differs	Self-custody wallet	Custodial exchange or broker	Other platform
What Yutai reads	The chains the distributor registered: Yutai reads the holder's wallets on them straight from the chain.	The registry instruments the distributor listed: the distributor signs what each account holds, and Yutai reads its signed word.	Nothing yet: no holdings channel stands for this kind, so Yutai reads no holdings from it.
What the distributor sends	Wallet addresses: one for each wallet the holder links. Nothing else about the holder.	A pseudonymous user reference for each account, and a short-lived signed statement of its holdings: never a name, an email address or a phone number.	Nothing yet: with no holdings channel, there is nothing for the platform to send about a holding.
How long a holder has held	The holding's own chain history, which Yutai reads; when no history stands, the first instant Yutai saw the holding at or above the floor.	The day the distributor's signed statement says the holding began.	Not yet: no holding is read for this kind, so no tenure is counted from it.
How a claim is proven	The holder signs a one-time message Yutai issues for the claim.	The distributor's own signature stands beside the claim.	Not yet: with no holdings channel, a claim has no holding behind it to prove.

What Yutai reads: Self-custody wallet. The chains the distributor registered: Yutai reads the holder's wallets on them straight from the chain.; Custodial exchange or broker. The registry instruments the distributor listed: the distributor signs what each account holds, and Yutai reads its signed word.; Other platform. Nothing yet: no holdings channel stands for this kind, so Yutai reads no holdings from it.
What the distributor sends: Self-custody wallet. Wallet addresses: one for each wallet the holder links. Nothing else about the holder.; Custodial exchange or broker. A pseudonymous user reference for each account, and a short-lived signed statement of its holdings: never a name, an email address or a phone number.; Other platform. Nothing yet: with no holdings channel, there is nothing for the platform to send about a holding.
How long a holder has held: Self-custody wallet. The holding's own chain history, which Yutai reads; when no history stands, the first instant Yutai saw the holding at or above the floor.; Custodial exchange or broker. The day the distributor's signed statement says the holding began.; Other platform. Not yet: no holding is read for this kind, so no tenure is counted from it.
How a claim is proven: Self-custody wallet. The holder signs a one-time message Yutai issues for the claim.; Custodial exchange or broker. The distributor's own signature stands beside the claim.; Other platform. Not yet: with no holdings channel, a claim has no holding behind it to prove.