Skip to main content
POST
Create an account from a guest order

Authorizations

Authorization
string
header
required

API Key Authentication

Use your API key in the Authorization header:

Key Types:

Secret Keys (Server-Side Only):

  • Format: tybrite_sk_live_* (production) or tybrite_sk_test_* (sandbox)
  • Full read/write access to all endpoints
  • ⚠️ NEVER expose in client-side code or public repositories
  • Required for: every write a shopper does not make for themselves, authentication, payment verification, AI recommendations

Publishable Keys (Client-Safe):

  • Format: tybrite_pk_live_* (production) or tybrite_pk_test_* (sandbox)
  • Catalogue reads, plus the actions a shopper takes for themselves
  • ✅ Safe for client-side JavaScript, mobile apps, and public code
  • Allowed for: browsing products, search, CMS content, pricing queries, cart and wishlist, reviews, storefront events, and the Agent API's quotes, cart drafts and checkout intents

Endpoint-Specific Requirements:

  • Authentication endpoints (/v1/auth/*): Secret key required
  • Payment verification (POST /v1/payments/verify): Secret key required
  • AI Recommendations (POST /v1/recommendations): Secret key required
  • Semantic Search (POST /v1/search): Both key types allowed (read-only operation)
  • Shopper actions (cart, wishlist, reviews, storefront events, Agent API quotes, cart drafts and checkout intents): Both key types allowed
  • All other write operations: Secret key required
  • All read operations: Both key types allowed

Using a publishable key for restricted operations returns 403 Forbidden.

Body

application/json
order_id
string<uuid>
required

The order the token was issued for.

claim_token
string
required

The claim_token from the order's create response.

password
string
required

The new account's password. Same rule as registration.

Required string length: 8 - 72
name
string

The shopper's name. Defaults to the name on the order.

Response

Account created and signed in.

A successful sign-in, sign-up verification or password reset.

message
string
required
user
object
required

The shopper's sign-in identity.

customer
object | null
required

The shopper's customer record at this store. null when the key belongs to a marketplace, where a shopper holds an account without a per-store record.

session
object
required

A shopper's session with the store: a short-lived sign-in token and a refresh token. Store both values and replace them on every refresh.