Skip to main content
Create a link
Call this from your backend after the OAuth code exchange. See Link from your app.

Authorizations

Authorization
string
header
required

Preferred. An access token your partner client mints with the client credentials grant. Send it only on the Authorization header. It is not the member access token from the code exchange.

Body

application/json
idToken
string
required

The id_token from your code exchange with the Bilt IdP, sent as issued. Its sub names the Bilt member. Do not decode, rewrite, or reuse it.

Required string length: 1 - 8192
partnerUserId
string
required

Your stable, opaque id for the account. It is the only handle for the link afterwards. Do not put personal data in it.

Required string length: 1 - 256

Response

Link created. A byte-identical retry of a request that already succeeded returns the same link.

The id of this link episode. Store it; you send it to end the link.

partnerUserId
string
required

Your account id.

LINKED is the only usable state. UNLINKED means the member or Bilt support ended the link. LINK_REVOKED means you ended it. UNLINKING_IN_PROGRESS means Bilt is calling you to end it: treat it as unusable but not final, and read it again. A new link after UNLINKED or LINK_REVOKED creates a fresh link.

Available options:
LINKED,
UNLINKED,
LINK_REVOKED,
UNLINKING_IN_PROGRESS
linkedAt
string<date-time>

When the link was created.

partnerDetails
object

Reserved. Currently always an empty object.