Skip to main content
POST
Resend the confirmation email

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
email
string<email>
required

The address that registered.

Example:

"john.doe@example.com"

redirect_to
string<uri>

Storefront page that receives the shopper from the email. Must be on one of the store's allowed storefront origins, or it is ignored.

Example:

"https://shop.example.com/account?link=register"

Response

Accepted. The body is the same for every address.

The answer to a sign-up request. It is identical whether or not the address already has an account, and it carries no session: a session is issued by POST /v1/auth/register/verify.

status
enum<string>
required
Available options:
verification_required
email
string
required

The address exactly as it was submitted.

expires_in
integer
required

Seconds for which the emailed code and link remain valid (900).

Example:

900